MaCh3 SBI TOOLS
==================================================
.. container:: badges

   .. image:: https://img.shields.io/badge/License-GPLv3-blue.svg
      :target: https://www.gnu.org/licenses/gpl-3.0
      :alt: license

   .. image:: https://codecov.io/github/henry-wallace-phys/mach3sbitools/graph/badge.svg?token=LY1UV4USFH
      :target: https://codecov.io/github/henry-wallace-phys/mach3sbitools
      :alt: codecov.io

   .. image:: https://img.shields.io/badge/Code-Documented-2ea44f
      :target: https://henry-wallace-phys.github.io/MaCh3SbiTools
      :alt: Code - Documented

   .. image:: https://github.com/henry-wallace-phys/MaCh3SbiTools/actions/workflows/pytest.yml/badge.svg
      :target: https://github.com/henry-wallace-phys/MaCh3SbiTools/actions/workflows/pytest.yml
      :alt: unit tests

   .. image:: https://github.com/henry-wallace-phys/MaCh3SbiTools/actions/workflows/github-code-scanning/codeql/badge.svg
      :target: https://github.com/henry-wallace-phys/MaCh3SbiTools/actions/workflows/github-code-scanning/codeql
      :alt: CodeQL

   .. image:: https://github.com/henry-wallace-phys/MaCh3SbiTools/actions/workflows/mypy.yml/badge.svg
      :target: https://github.com/henry-wallace-phys/MaCh3SbiTools/actions/workflows/mypy.yml
      :alt: mypy-typecheck

   .. image:: https://github.com/henry-wallace-phys/MaCh3SbiTools/actions/workflows/ruff.yml/badge.svg
      :target: https://github.com/henry-wallace-phys/MaCh3SbiTools/actions/workflows/ruff.yml
      :alt: ruff-lint

   .. image:: https://github.com/henry-wallace-phys/MaCh3SbiTools/actions/workflows/docs.yml/badge.svg
      :target: https://github.com/henry-wallace-phys/MaCh3SbiTools/actions/workflows/docs.yml
      :alt: Build & Deploy Sphinx Docs


MaCh3 SBI Tools is a package used to perform
Bayesian Simulation based inference with a flexible simulator and training setup using tools from the SBI :cite:`BoeltsDeistler_sbi_2025` package. The simulator is designed to work primarily with MaCh3 :cite:`the_mach3_collaboration_2026_18627288`.

----

.. toctree::
   :caption: Introduction

   modules/intro


.. toctree::
   :caption: Getting Started
   :maxdepth: 2

   modules/getting_started/getting_started


.. toctree::
   :caption: API Reference Guide
   :maxdepth: 1

   modules/api_reference/api_reference

.. toctree::
   :caption: References
   :maxdepth: 1

   modules/references