Skip to content

# Navigation

The structure of this software package is described on the "Software design" page, which is also accessible via the sidebar.

Installation notes are available on the "How to install" page. Notes on running simulations are available on the corresponding "How to run" page.

Links to demo scripts are provided under "Demos". See Simulation tools for more complete examples and further information.

The key driver of a simulation is the `Info.json` file: care must be taken to match the "job name" implied by this file (a string constructed from the model coefficients and parameters specified by it) with its parent folder name, such that output files are placed correctly.

Refer to the links under "Python modules" to see documentation of the `langevin` Python package. The underlying `C++` core is documented under "C++ source" using `Doxygen`.