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

Documentation for using MARCS to generate a .mod file for STARDIS #227

Merged
merged 5 commits into from
Nov 25, 2024

Conversation

RyanGroneck
Copy link
Contributor

📝 Description

Type: 📝 documentation

This is a first draft of some documentation that tells the user how to use MARCS to get a file useable for STARDIS and run a STARDIS simulation with it. Make sure to keep an eye on if I misused terminology or something silly like that as I'm still new to this. lastly, right now the new documentation is just floating in a directory made specifically for it, I am unsure as to where that directory should live so that will likely need to be changed.

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

@jvshields jvshields added the documentation Improvements or additions to documentation label Nov 4, 2024
@@ -0,0 +1,128 @@
{
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.

Not sure why this text looks different.


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.

fixed in 'typo and format fix'

@@ -0,0 +1,128 @@
{
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.

Typo "bellow"

Also again, not quite sure why the first line text looks different from the next.


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.

fixed in 'typo and format fix'

@jvshields jvshields merged commit 6351d08 into tardis-sn:main Nov 25, 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
documentation Improvements or additions to documentation
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants