Documentation and Tutorials

The online documentation contains user-friendly and reference manuals of the SBL, together with tutorials for a large variety of users.


The documentation is accessible from here.

Each package comes with its user manual and reference manual. The former contains high level information on how to use a package, while the later precisely describes precisely the C++ (or python) data structures used and/or provided. More specifically:

Applications. For a package in Applications, the user manual describes the problem solved by the application, and explain how to use the different programs provided. Program runs are presented using illustrative examples (with input files, command-line options, output files). The workflow of the application is represented by an interactive graph where each node is a step of the application, linked to a package of the SBL.

Models. For a package in Models, the user manual describes the (biophysical) concept associated with the package. The available models are listed with a short explanation on how to use them, and the creation of new models is illustrated by examples.

Core. For a package in Core, the user manual describes the generic algorithms and data structures provided by the package. It provides short examples illustrating how to instantiate the C++ classes in simple contexts.


Tutorials are provided for different users of the SBL.

Tutorial for installing the SBL: focuses on the installation of the SBL.

Tutorial for end-users: focuses on calculations with existing programs, and on navigation issues within the documentation.

Tutorial for developers: focuses on the development of novel programs obtained by plugging novel models into an existing application, and also on the development of novel applications (using in particular the workflow framework).