..
  .. image:: graphics/tardis_logo.jpg

.. the "raw" directive below is used to hide the title in favor of just the logo being visible
.. .. raw:: html

..    <style media="screen" type="text/css">
..      h1 { display:none; }
..    </style>

##################################
TARDIS Core Package Documentation
##################################

.. image:: graphics/tardis_banner.svg

|

TARDIS is an open-source :term:`Monte Carlo` radiative-transfer spectral synthesis code
for 1D models of supernova ejecta. It is designed for rapid spectral modelling
of supernovae. It is developed and maintained by a 
`multi-disciplinary team <https://tardis-sn.github.io/people/collaboration/>`_
including software engineers, computer scientists, statisticians,
and astrophysicists.

The tardis package is the core package provided by the TARDIS Project. To learn
more about the complete project, other packages it provides, and the community
behind it, please check the `project website <https://tardis-sn.github.io>`_.

If you use this code for any publications or presentations please follow our
citation guidelines in :ref:`tardiscredits`.

User modifications and additions that lead to publications **need to be handed
back to the community** by incorporating them into TARDIS.
Please contact the TARDIS team via the `GitHub page
<https://github.com/tardis-sn/tardis>`_ if you have questions or need
assistance.

------------------------------
Documentation Structure Guide
------------------------------

This documentation is organized following the `Diátaxis framework <https://diataxis.fr/>`_:

- **Getting Started**: Quick installation and first steps
- **Tutorials**: Step-by-step lessons for learning TARDIS concepts
- **How-to Guides**: Practical solutions to specific problems  
- **Physics Walkthrough**: Deep dives into the physics and theory behind TARDIS
- **Reference**: Technical specifications and API documentation


-----------------
Mission Statement
-----------------

    *The mission of the TARDIS community is to develop open-source software 
    instruments to analyze and simulate astronomical transients 
    (supernovae, kilonovae, etc.) for research and education purposes. 
    We aim to build up a diverse group of researchers and developers 
    using an open-community model that emphasizes interdisciplinary 
    research and science reproducibility.* 

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

    getting_started/installation
    quickstart
    resources/credits

.. toctree::
    :maxdepth: 2
    :caption: Tutorials
    :hidden:

    tutorials/high_energy/run_high_energy_workflow
    analyzing_tardis/visualization/tutorial_montecarlo_packet_visualization

.. toctree::
    :maxdepth: 2
    :caption: How-to Guides
    :hidden:

    how_to_guides
    workflows
    analyzing_tardis/index
    io/configuration/tutorial_read_configuration
    io/optional/index
    io/output/index
    how-to/code_comparison/index

.. toctree::
    :maxdepth: 2
    :caption: Physics Walkthrough
    :hidden:

    physics_walkthrough/intro/index
    physics_walkthrough/setup/index
    physics_walkthrough/montecarlo/index
    physics_walkthrough/update_and_conv/update_and_conv
    physics_walkthrough/spectrum/index
    physics_walkthrough/tardisgamma/index

.. toctree::
    :maxdepth: 2
    :caption: Reference
    :hidden:

    API <api/modules>
    reference/faq
    reference/visualization_reference
    io/configuration/index
    io/hdf/index
    contributing/CHANGELOG.md 
    resources/research_done_using_TARDIS/research_papers
    resources/zreferences

.. toctree::
    :maxdepth: 2
    :caption: Contributing to TARDIS
    :hidden:

    contributing/CONTRIBUTING.md
    contributing/development/index
    contributing/tools/index
    contributing/in_progress/index