Documentation for using/getting a new CARSUS atom_data file for STARDIS

RyanGroneck commented 4 weeks ago

:pencil: Description

Type: :memo: documentation

This is a first draft of the STARDIS documentation to show someone how to get a relevant atomic_data file from CARSUS and how to use that new data in a STARDIS simulation. Keep an eye out to make sure I didn't use wrong terminology or explain something incorrectly as I'm still new to this :)

:pushpin: Resources

Examples, notebooks, and links to useful references.

:vertical_traffic_light: Testing

How did you test these changes?

[ ] Testing pipeline
[ ] Other method (describe)
[ ] My changes can't be tested (explain why)

:ballot_box_with_check: Checklist

[ ] I requested two reviewers for this pull request
[ ] I updated the documentation according to my changes
[ ] I built the documentation by applying the build_docs label

Note: If you are not allowed to perform any of these actions, ping (@) a contributor.

review-notebook-app[bot] commented 4 weeks ago

Check out this pull request on

See visual diffs & provide feedback on Jupyter Notebooks.

Powered by ReviewNB

RyanGroneck commented 4 weeks ago

in the added part for vald_linelist, I was unsure what shortlist: <boolean> is used for, so that will need to be expanded upon (presumably)

jvshields commented 3 weeks ago

It might be easier to look at my comments on ReviewNB. It's a bit harder to tell which lines I'm talking about on github.

jvshields commented 3 weeks ago

You will also need to add this file to the index.rst file in docs to have it show up when the documentation gets built. Take a look at that and how you need to include it there.

tardis-sn / stardis