API reference
=============

This section documents the public Python API of :mod:`barc4beams`.
Most users will interact primarily with the :class:`barc4beams.beam.Beam`
container and a few high-level helper functions, but all modules are
listed for completeness.

Beam container
--------------

.. automodule:: barc4beams.beam
   :members:
   :undoc-members:
   :show-inheritance:


Propagation
-----------

.. automodule:: barc4beams.propagation
   :members:
   :undoc-members:


Sampling
--------

.. automodule:: barc4beams.sampling
   :members:
   :undoc-members:


Statistics
----------

.. automodule:: barc4beams.stats
   :members:
   :undoc-members:


I/O utilities
-------------

.. automodule:: barc4beams.io
   :members:
   :undoc-members:


Visualization
-------------

.. automodule:: barc4beams.viz
   :members:
   :undoc-members:


Adapters
--------

.. automodule:: barc4beams.adapters
   :members:
   :undoc-members:


Schema
------

.. automodule:: barc4beams.schema
   :members:
   :undoc-members:


Miscellaneous helpers
---------------------

.. automodule:: barc4beams.misc
   :members:
   :undoc-members: