Using Rameau

You can use Rameau either through the command line interface (CLI) or through the Python API. The command line interface is a convenient way to run simulations without writing code. The Python API is more flexible and allows you to build more complex models and use the Python ecosystem.

To use Rameau through its CLI, you need to write a TOML configuration file that describes the settings and physical parameters of your model. This file is then passed to the Rameau executable as an argument to run the model:

rameau-cli my_model.toml

To use Rameau through the API, see Quick overview