DEISM Documentation
===================

DEISM is a Python package for room-acoustics simulation with directivity-aware
source and receiver models. The current documentation is organized around the
class-based workflow implemented by ``deism.core_deism.DEISM``.

Start here
----------

* :doc:`introduction` for the project scope and published references
* :doc:`installation` for environment setup and verification
* :doc:`quickstart` for the shortest working class-based runs
* :doc:`workflows` for shoebox versus convex execution order
* :doc:`parameter_dependencies` for update-order and rerun rules

Quick Links
-----------

* :ref:`academic-publications` - Jump to all publications
* :ref:`main-paper` - Main JASA paper
* :ref:`directivity-paper` - Directivity formulation paper
* :ref:`iwaenc-paper` - Arbitrary geometries paper

.. toctree::
   :maxdepth: 2
   :caption: Contents:

   introduction
   installation
   quickstart
   workflows
   configuration
   parameter_dependencies
   examples
   api_reference
   troubleshooting

Indices and tables
==================

* :ref:`genindex`
* :ref:`modindex`
* :ref:`search`