sandbox/documentation

Basilisk’s documentation

This page aims to provide an overview of the available documentation for Basilisk.

Getting started

• The website frontpage
  
• Solvers and functions
• Installation instructions and for Mac OS X
  
• Tutorial
  
• Learn from examples
  
• Basilisk C
• Dimensional Analysis Tutorial

Further reading

• Test cases
• Some tips
  
• Compatibility matrix
• Bug reports
• Discussion group of Basilisk (user forum)
  
• Browse the source code
  
• Built-in speed performance profiling
  
• Built-in Memory profiling

Basilisk view (bview)

• Runtime graphics generation
• Installation
• The draw commands
  
• Interactive bview

The wiki

• Introduction to the wiki
  
• How to contribute
  
• Play in the sandbox
  
• Review recent activity

Install useful libraries

• GOTM for the layered solver
• CVMix for the layered solver
• PPR remapping for the layered solver (just make it)
• KDT for terrain datasets (installed with Basilisk)
• OpenGL (see Basilisk view)

Documentation in the sandbox

A non-exhaustive list of documentation attempts, mostly writen by users.

• Frequently alphabetic questions (FAQ)
  
• The tree-grid structure in Basilisk
  
• The wavelet-based adaptation algorithm
  
• Another tutorial
  
• Yet another tutorial
• A descriptive take on the centered Navier-Stokes solver
  
• Complete installation of bview
  
• Install Mesa on a supercomputer
• Workaround for a faulty system-maintained OSMesa installation

Notable publications

• Stephane Popinet’s (2015) Serre-Green-Naghdi paper
  
• Other publications in Basilisk’s bibliography

Miscellaneous

• Wish list
  
• To do list and project ideas
  
• The Authors
  
• The license
  
• Basilisk on GPUs
  
• Performance profiling with paraver
  
• Round-off error estimation with CADNA
  
• How to configure a Basilisk server