Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

new Documentation for setting amount of threads used in STARDIS simul… #228

Merged
merged 4 commits into from
Nov 18, 2024

Conversation

RyanGroneck
Copy link
Contributor

…ation

📝 Description

Type: 📝 documentation

First draft of documentation that explains n_threads: <integer> in yaml files, so how to set the number of threads used in a STARDIS simulation. Make sure I used terminology right, and there are probably more technical ways to phrase some parts. Also this documentation is very short, later it might want to be bundled into a larger notebook that covers similar features. This notebook is also just put in a new directory and will probably need a better place to live in the program.

Also, link issues affected by this pull request by using the keywords: close, closes, closed, fix, fixes, fixed, resolve, resolves or resolved.

📌 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.

Copy link

Check out this pull request on  ReviewNB

See visual diffs & provide feedback on Jupyter Notebooks.


Powered by ReviewNB

@@ -0,0 +1,63 @@
{
Copy link
Contributor

@jvshields jvshields Nov 4, 2024

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I would add a note that this helps when computing spectra with large numbers of wavelength points (i.e., more than 10,000 or so), and it specifically parallelizes the line opacity calculation and ray tracing steps.


Reply via ReviewNB

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

added in 'more info added: parallelized stuff and when to use'

docs/index.rst Outdated Show resolved Hide resolved
@jvshields jvshields merged commit ab7e61d into tardis-sn:main Nov 18, 2024
3 of 5 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants