Event Generators
================

This package contains all code related to physics generators. Please have a
look at `Overview of the Belle II Physics Generators`_. As a general rule users
are strongly encouraged to use the functions provided by the `generators`
python module and not manually add generator modules directly to the path.

.. _Overview of the Belle II Physics Generators: https://docs.belle2.org/record/282?ln=en


The generators Python Module
----------------------------

.. automodule:: generators
   :members:


Modules in the Generators Package
---------------------------------

Apart from the default settings above the generators can also be setup directly
and there are special generators not covered above. 

.. warning:: Please use the function from the generators module to setup event generation if possible.

.. b2-modules:: 
   :package: generators