Skip to content

Commit

Permalink
Adding to Readme (#181)
Browse files Browse the repository at this point in the history
* Added MARCS_TEST_FPATH, removed redundancies

* Use model fixture in all tests

* Combined all marcs tests

* Add relevant links to README file

* Add correct hyperlinks and clearer language

* Add whitespace before license

---------

Co-authored-by: Hayden James Monk <[email protected]>
  • Loading branch information
haydenmonk and Hayden James Monk committed Apr 15, 2024
1 parent 99bc5dc commit 74ce810
Showing 1 changed file with 8 additions and 0 deletions.
8 changes: 8 additions & 0 deletions README.rst
Original file line number Diff line number Diff line change
@@ -1,6 +1,14 @@
STARDIS Stellar Radiative transfer
----------------------------------

Welcome to STARDIS!
STARDIS is an LTE radiative transfer Python package that utilizes the TARDIS infrastructure
to generate synthetic stellar spectra. For more information about STARDIS,
including a quickstart notebook, physics walkthrough and installation instructions, go to our `documentation page <https://tardis-sn.github.io/stardis/>`_.
Or, try running the `quickstart notebook <docs/quickstart/quickstart.ipynb>`_ yourself!

To learn more about TARDIS, including documentation and collaborator information, go `here <https://tardis-sn.github.io/tardis/>`_.

License
-------

Expand Down

0 comments on commit 74ce810

Please sign in to comment.