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

Fixing various physics documentation issues #1928

Merged
merged 4 commits into from
Mar 23, 2022

Conversation

isaacgsmith
Copy link
Member

@isaacgsmith isaacgsmith commented Mar 14, 2022

Description

  • Fixed an error on the propagation page regarding the accumulation of optical depth after reaching a cell boundary.
  • Added a figure to the discussion about the propagation direction in the initialization notebook.
  • Explicitly mentioned the relationship between initialized packet frequency and the number of photons it represents.
  • Added information about reference frames in the initialization and spectrum generation notebooks.
  • Revised the treatment of the photospheric temperature in the initialization and spectrum generation notebooks.
  • Removed an outdated note from the quickstart notebook.
  • Other small notation and organizational changes to make the documentation more readable and consistent.

How has this been tested?

  • Testing pipeline.
  • Docs built locally and on GitHub.

Examples

Pages with significant changes:
https://smithis7.github.io/tardis/branch/physics_fix_doc/physics/setup/model.html
https://smithis7.github.io/tardis/branch/physics_fix_doc/physics/montecarlo/initialization.html
https://smithis7.github.io/tardis/branch/physics_fix_doc/physics/spectrum/basic.html

Type of change

  • Bug fix.
  • New feature.
  • Breaking change.
  • None of the above.

Checklist

  • My change requires a change to the documentation.
    • I have updated the documentation accordingly.
    • (optional) I have built the documentation on my fork following the instructions.
  • I have assigned and requested two reviewers for this pull request.

@review-notebook-app
Copy link

Check out this pull request on  ReviewNB

See visual diffs & provide feedback on Jupyter Notebooks.


Powered by ReviewNB

@wkerzendorf
Copy link
Member

@smithis7 uuuh - tests fail - what have you done 🤣

@isaacgsmith
Copy link
Member Author

@smithis7 uuuh - tests fail - what have you done 🤣

I’ll look into it. I only edited within the docs/ directory so I have no clue…

@isaacgsmith
Copy link
Member Author

@smithis7 uuuh - tests fail - what have you done 🤣

I just rebased and it now passes.

@tardis-bot
Copy link
Contributor

Before a pull request is accepted, it must meet the following criteria:

  • Is the necessary information provided?
  • Is this a duplicate PR?
    • If a new PR is clearly a duplicate, ask how this PR is different from the original PR?
    • If this PR is about to be merged, close the original PR with a link to this new PR that solved the issue.
  • Does it pass existing tests and are new tests provided if required?
    • The test coverage should not decrease, and for new features should be close to 100%.
  • Is the code tidy?
    • No unnecessary print lines or code comments.

@isaacgsmith isaacgsmith mentioned this pull request Mar 15, 2022
10 tasks
@andrewfullard andrewfullard merged commit e7c2ec3 into tardis-sn:master Mar 23, 2022
@isaacgsmith isaacgsmith deleted the physics_fix_doc branch March 28, 2022 18:50
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

5 participants