From 74ce810af152e755e2a97af80b3163ec6a240f71 Mon Sep 17 00:00:00 2001 From: haydenmonk <113469153+haydenmonk@users.noreply.github.com> Date: Mon, 15 Apr 2024 11:30:35 -0400 Subject: [PATCH] Adding to Readme (#181) * 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 --- README.rst | 8 ++++++++ 1 file changed, 8 insertions(+) diff --git a/README.rst b/README.rst index 3d54178f..3a4d3b66 100644 --- a/README.rst +++ b/README.rst @@ -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 `_. +Or, try running the `quickstart notebook `_ yourself! + +To learn more about TARDIS, including documentation and collaborator information, go `here `_. + License -------