Simulation Module
=================

The :mod:`cdiutils.simulation` module provides tools for simulating BCDI data.

.. automodule:: cdiutils.simulation
   :members:
   :undoc-members:
   :show-inheritance:

Key Functions
-------------

.. currentmodule:: cdiutils.simulation

.. autosummary::
   :toctree: ../generated/

   simulate_crystal
   generate_diffraction_pattern
   add_noise
   simulate_detector_frame

See Also
--------
:doc:`../examples/simulation` : Simulation tutorials and examples