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

[RyanGroneck]

📝 Description

Type: 📝 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 :)

📌 Resources

Examples, notebooks, and links to useful references.

🚦 Testing

How did you test these changes?

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

☑️ 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]

Check out this pull request on 

See visual diffs & provide feedback on Jupyter Notebooks.

---

Powered by ReviewNB

[RyanGroneck]

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]

Make sure to use a spellchecker on your documentation. "quntities" is mispelled.

I'm not sure I'd make the distinction between elements and atoms, but also CARSUS can include molecular information and does not particularly include information on the quantities of chemicals in the model, so I'd just say explicitly "on the properties or atoms and molecules needed by STARDIS."

Also, I'd remove the part about kurucz being recommended. Rather, I'd say that, for a detailed and accurate stellar spectrum we highly recommend looking into using a VALD linelist bundled into your atomic data.

Reply via ReviewNB

[jvshields]

"STARDUS" typo

Also, "strictly necessarily" is probably supposed to be "necessary." That said, I wouldn't say "necessary" anyway, since you don't technically need a VALD linelist or molecular data from Barklem & Collet. I'd just say that they're recommended.

Reply via ReviewNB

[jvshields]

Try to be a bit more intentional with which font styles you're using when. It's a bit odd how this text is small and bold, and different from other text.

Reply via ReviewNB

[jvshields]

Weird command and then period at the end of this line.

Reply via ReviewNB

[jvshields]

The shortlist flag is relevant to the format of the linelist. VALD can output lists in either "long" form or "short" form, so you need to tell STARDIS which one it is.

Reply via ReviewNB

[jvshields]

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]

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.