Configuration
=============

.. toctree::
   :maxdepth: 5

   files
   beam
   beam_calculator
   plots
   wtf
   design_space
   evaluators

Most of the configuration of LightWin is performed through a `TOML` configuration file, which should be given as argument to several objects initialisation.
The configuration file is treated with the help of the `tomllib <https://docs.python.org/3/library/tomllib.html>`_ module.
It is processed by the :func:`.config.config_manager.process_config` function, which checks its validity and converts it to a dictionary.

The name of every section is not important, as long as every section is correctly passed to :func:`.config.config_manager.process_config`.
It is however recommended to use explicit names.

.. rubric:: Example for the ``beam`` section

.. code-block:: toml

   [beam_proton]     # this could be [bonjoure] or anything
   e_rest_mev = 938.27203
   q_adim = 1.0
   e_mev = 20.0
   f_bunch_mhz = 350.0
   i_milli_a = 25.
   sigma = [
      [ 1e-6, -2e-7, 0.0,   0.0,  0.0,   0.0],
      [-2e-7,  8e-7, 0.0,   0.0,  0.0,   0.0],
      [ 0.0,   0.0,  1e-6, -2e-7, 0.0,   0.0],
      [ 0.0,   0.0, -2e-7,  8e-7, 0.0,   0.0],
      [ 0.0,   0.0,  0.0,   0.0,  1e-6, -2e-7],
      [ 0.0,   0.0,  0.0,   0.0, -2e-7,  8e-7],
   ]

   [beam_proton_no_space_charge]   # or [sdaflghsh] but it would be less explicit in my humble opinion
   e_rest_mev = 938.27203
   q_adim = 1.0
   e_mev = 20.0
   f_bunch_mhz = 350.0
   i_milli_a = 0.0
   sigma = [
      [ 1e-6, -2e-7, 0.0,   0.0,  0.0,   0.0],
      [-2e-7,  8e-7, 0.0,   0.0,  0.0,   0.0],
      [ 0.0,   0.0,  1e-6, -2e-7, 0.0,   0.0],
      [ 0.0,   0.0, -2e-7,  8e-7, 0.0,   0.0],
      [ 0.0,   0.0,  0.0,   0.0,  1e-6, -2e-7],
      [ 0.0,   0.0,  0.0,   0.0, -2e-7,  8e-7],
   ]


.. note::
   In order to dynamically keep track of the options that are implemented, the *Allowed values* column of following tables contains a link to the variable storing the possible values, when relevant.