tardis-sn

TARDIS - Temperature And Radiative Diffusion In Supernovae

https://github.com/tardis-sn/tardis

Keywords

Keywords from Contributors

Repository

TARDIS - Temperature And Radiative Diffusion In Supernovae

README.rst

======
TARDIS
======

.. image:: https://img.shields.io/badge/Donate-to%20TARDIS-brightgreen.svg
    :target: https://numfocus.salsalabs.org/donate-to-tardis/index.html

.. image:: https://img.shields.io/badge/powered%20by-NumFOCUS-orange.svg?style=flat&colorA=E1523D&colorB=007D8A
    :target: http://numfocus.org

.. image:: https://badges.gitter.im/Join%20Chat.svg
    :target: https://gitter.im/tardis-sn/tardis

.. image:: https://img.shields.io/static/v1?logo=visualstudiocode&label=&message=Open%20in%20Visual%20Studio%20Code&labelColor=2c2c32&color=007acc&logoColor=007acc
    :target: https://open.vscode.dev/tardis-sn/tardis
|

TARDIS is a tool that creates synthetic observations (*spectra*) for exploding
stars (*supernovae*).

.. image:: https://codecov.io/gh/tardis-sn/tardis/branch/master/graph/badge.svg
    :target: https://codecov.io/gh/tardis-sn/tardis

.. image:: https://github.com/tardis-sn/tardis/actions/workflows/docstr-cov.yml/badge.svg
    :target: https://github.com/tardis-sn/tardis/actions/workflows/docstr-cov.yml

.. image:: https://github.com/tardis-sn/tardis/actions/workflows/tests.yml/badge.svg
    :target: https://github.com/tardis-sn/tardis/actions/workflows/tests.yml

.. image:: https://github.com/tardis-sn/tardis/actions/workflows/build-docs.yml/badge.svg
    :target: https://tardis-sn.github.io/tardis/index.html

.. image:: https://img.shields.io/badge/benchmarks-passing-green
    :target: https://github.com/tardis-sn/tardis/actions/workflows/benchmarks.yml

.. image:: https://img.shields.io/endpoint?url=https://raw.githubusercontent.com/tardis-sn/tardis/master/docs/_static/ruff_badge.json
    :target: https://github.com/tardis-sn/tardis/actions/workflows/codestyle.yml
|

.. _tardiscredits:

******************************
Credits & Publication Policies
******************************

|DOI_BADGE|

We provide TARDIS as a free, open-source tool. If you are using it, please
adhere to a few policies and acknowledge the TARDIS Team.

Publication Policies
====================

If you use this code for any publications or presentations please acknowledge
it.  Please cite `Kerzendorf & Sim 2014
`_  in the text and add the
following paragraph to the Acknowledgement section:

.. parsed-literal::

    This research made use of \\textsc{tardis}, a community-developed software package for spectral
    synthesis in supernovae \\citep{2014MNRAS.440..387K, |CITATION|}. The
    development of \\textsc{tardis} received support from GitHub, the Google Summer of Code
    initiative, and from ESA's Summer of Code in Space program. \\textsc{tardis} is a fiscally
    sponsored project of NumFOCUS. \\textsc{tardis} makes extensive use of Astropy and Pyne.

If you use any of the full relativity treatments or use TARDIS for modelling
Type II supernovae, also add `Spectral modeling of type II supernovae. I. Dilution factors `_
to the Acknowledgement.

.. parsed-literal::

    \citep{2019A&A...621A..29V}

The following BibTeX entries are needed for the references:

.. code-block:: bibtex

    @ARTICLE{2014MNRAS.440..387K,
           author = {{Kerzendorf}, W.~E. and {Sim}, S.~A.},
            title = "{A spectral synthesis code for rapid modelling of supernovae}",
          journal = {\mnras},
    archivePrefix = "arXiv",
           eprint = {1401.5469},
     primaryClass = "astro-ph.SR",
         keywords = {radiative transfer, methods: numerical, supernovae: general},
             year = 2014,
            month = may,
           volume = 440,
            pages = {387-404},
              doi = {10.1093/mnras/stu055},
           adsurl = {http://adsabs.harvard.edu/abs/2014MNRAS.440..387K},
          adsnote = {Provided by the SAO/NASA Astrophysics Data System}
    }

.. code-block:: bibtex

    @ARTICLE{2019A&A...621A..29V,
           author = {{Vogl}, C. and {Sim}, S.~A. and {Noebauer}, U.~M. and {Kerzendorf}, W.~E. and {Hillebrandt}, W.},
            title = "{Spectral modeling of type II supernovae. I. Dilution factors}",
          journal = {\aap},
         keywords = {radiative transfer, methods: numerical, stars: distances, supernovae: general, supernovae: individual: SN1999em, Astrophysics - High Energy Astrophysical Phenomena, Astrophysics - Solar and Stellar Astrophysics},
             year = "2019",
            month = "Jan",
           volume = {621},
              eid = {A29},
            pages = {A29},
              doi = {10.1051/0004-6361/201833701},
    archivePrefix = {arXiv},
           eprint = {1811.02543},
     primaryClass = {astro-ph.HE},
           adsurl = {https://ui.adsabs.harvard.edu/abs/2019A&A...621A..29V},
          adsnote = {Provided by the SAO/NASA Astrophysics Data System}
    }

.. |CITATION| replace:: kerzendorf_2025_17010211

.. |DOI_BADGE| image:: https://img.shields.io/badge/DOI-10.5281/zenodo.17010211-blue
                 :target: https://doi.org/10.5281/zenodo.17010211

.. code-block:: bibtex

    @software{kerzendorf_2025_17010211,
      author       = {Kerzendorf, Wolfgang and
                      Sim, Stuart and
                      Vogl, Christian and
                      Williamson, Marc and
                      Pssaro, Ezequiel and
                      Flrs, Andreas and
                      Camacho, Yssa and
                      Janauskas, Vytautas and
                      Harpole, Alice and
                      Nbauer, Ulrich and
                      Lietzau, Stefan and
                      Mishin, Mikhail and
                      Tsamis, Fotis and
                      Boyle, Aoife and
                      Shingles, Luke and
                      Gupta, Vaibhav and
                      Desai, Karan and
                      Klauser, Michael and
                      Beaujean, Frederik and
                      Suban-Loewen, Adam and
                      Heringer, Epson and
                      Barna, Barnabs and
                      Gautam, Gaurav and
                      Fullard, Andrew and
                      Arya, Atharva and
                      Smith, Isaac and
                      Cawley, Kevin and
                      Singhal, Jaladh and
                      Shields, Joshua and
                      O'Brien, Jack and
                      Barbosa, Talytha and
                      Sondhi, Dhruv and
                      Yu, Jenny and
                      Patel, Maryam and
                      Shields, Josh and
                      Varanasi, Kaushik and
                      Rathi, Shikha and
                      Chitchyan, Sona and
                      Gillanders, James and
                      Singh, Shreyas and
                      Savel, Arjun and
                      Gupta, Sumit and
                      Reinecke, Martin and
                      Holas, Alexander and
                      Eweis, Youssef and
                      Bylund, Tomas and
                      Black, William and
                      Bentil, Laud and
                      Kumar, Asish and
                      Eguren, Jordi and
                      Kumar, Ansh and
                      Bartnik, Matthew and
                      Alam, Arib and
                      Magee, Mark and
                      Dutta, Anirban and
                      Srivastava, Sarthak and
                      Varma Buddaraju, Rohith and
                      Visser, Erin and
                      Daksh, Ayushi and
                      Lu, Jing and
                      Livneh, Ran and
                      Kambham, Satwik and
                      Roldan, Israel and
                      Bhakar, Jayant and
                      Mishra, Sashank and
                      Rajagopalan, Srinath and
                      Reichenbach, John and
                      Jain, Rinkle and
                      Actions, GitHub and
                      Floers, Andreas and
                      Gupta, Harshul and
                      Chaumal, Aarya and
                      Brar, Antreev and
                      Singh, Sourav and
                      Kowalski, Nathan and
                      Patidar, Abhishek and
                      Matsumura, Yuki and
                      Selsing, Jonatan and
                      Sofiatti, Caroline and
                      Talegaonkar, Chinmay and
                      Kumar, Aman and
                      Sharma, Sampark and
                      Buchner, Johannes and
                      Yap, Kevin and
                      Martinez, Laureano and
                      Truong, Le and
                      Zingale, Michael and
                      Sandler, Morgan and
                      Zaheer, Musabbiha and
                      Sarafina, Nance and
                      Dasgupta, Debajyoti and
                      Patra, Nilesh and
                      Singh Rathore, Parikshit and
                      Patel, Pratik and
                      Volodin, Dmitry and
                      Venkat, Shashank and
                      Prasad, Shilpi and
                      Gupta, Suyash and
                      Lemoine, Thom and
                      Wahi, Ujjwal and
                      Aggarwal, Yash and
                      Chen, Nutan and
                      Kolliboyina, Chaitanya and
                      PATIDAR, ABHISHEK and
                      Nayak U, Ashwin and
                      Kumar, Atul and
                      Kharkar, Atharwa},
      title        = {tardis-sn/tardis: TARDIS v2025.08.31},
      month        = aug,
      year         = 2025,
      publisher    = {Zenodo},
      version      = {release-2025.08.31},
      doi          = {10.5281/zenodo.17010211},
      url          = {https://doi.org/10.5281/zenodo.17010211},
    }

*******
License
*******

.. image:: https://img.shields.io/conda/l/conda-forge/tardis-sn
    :target: https://github.com/tardis-sn/tardis/blob/master/licenses/LICENSE.rst

.. image:: http://img.shields.io/badge/powered%20by-AstroPy-orange.svg?style=flat
    :target: http://www.astropy.org
|

This project is Copyright (c) TARDIS Collaboration and licensed under
the terms of the BSD 3-Clause license. This package is based upon
the `Astropy package template `_
which is licensed under the BSD 3-clause license. See the licenses folder for
more information.

Owner

Committers

Last synced: about 2 years ago

Issues and Pull Requests

Last synced: 6 months ago

Packages