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

Incorporating old physics section of the documentation #1470

Merged

Conversation

isaacgsmith
Copy link
Member

This pull request incorporates the "old physics" section of the documentation into the updated physics section.

Description

Changes include:

  • Including doppler shift graph in docs/physics/montecarlo/propogation.rst.
  • Including tau_sobolev section and a summary of BasePlasma in docs/physics/plasma/index.rst.
  • Some minor changes in docs/physics/plasma/index.rst to give more context to the pages linked in toctrees.
  • Deleted docs/physics/old_physics/ and removed it from the toctree in ``docs/index.rst```.

Motivation and Context

This pull request addresses issue #1422.

How Has This Been Tested?

  • Testing pipeline
  • Reference Data Comparison following these instructions
  • Other (please describe)

I built the docs locally and made sure that no new warnings occurred.

Screenshots (if appropriate):

Types of changes

  • Bug fix (non-breaking change which fixes an issue)
  • New feature (non-breaking change which adds functionality)
  • Breaking change (fix or feature that would cause existing functionality to not work as expected)
  • None of the above (please describe)

Checklist:

  • My code follows the code style of this project
  • My change requires a change to the documentation
  • I have updated the documentation accordingly
  • I have built the documentation on my fork following these instructions
  • I have assigned and requested two reviewers for this pull request

@codecov
Copy link

codecov bot commented Feb 26, 2021

Codecov Report

Merging #1470 (eaab28d) into master (50f13ba) will not change coverage.
The diff coverage is n/a.

Impacted file tree graph

@@           Coverage Diff           @@
##           master    #1470   +/-   ##
=======================================
  Coverage   71.13%   71.13%           
=======================================
  Files          67       67           
  Lines        5523     5523           
=======================================
  Hits         3929     3929           
  Misses       1594     1594           

Continue to review full report at Codecov.

Legend - Click here to learn more
Δ = absolute <relative> (impact), ø = not affected, ? = missing data
Powered by Codecov. Last update 50f13ba...4890ae6. Read the comment docs.

@andrewfullard andrewfullard linked an issue Feb 26, 2021 that may be closed by this pull request
Copy link
Member

@jaladh-singhal jaladh-singhal left a comment

Choose a reason for hiding this comment

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

Thanks for this very essential PR - docs are neater now. Plasma section looks great.

And for montecarlo section, @smithis7 I'm assuming that you have confirmed with @wkerzendorf and/or @andrewfullard that we don't need anything except doppler shift graph from old documentation?

Copy link
Contributor

@andrewfullard andrewfullard left a comment

Choose a reason for hiding this comment

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

Will merge once the tests pass

@isaacgsmith
Copy link
Member Author

Will merge once the tests pass

Apparently the tests did not pass. I'm not entirely sure why.

@andrewfullard andrewfullard merged commit 9497250 into tardis-sn:master Mar 11, 2021
@isaacgsmith isaacgsmith deleted the old_physics_incorportation branch June 1, 2021 14:54
atharva-2001 pushed a commit to atharva-2001/tardis that referenced this pull request Oct 1, 2021
* incorporating old_physics

* adding distance calculation images
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.

Incorporate the old physics section of the documentation
3 participants