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

Formal integral documentation #1921

Merged
merged 13 commits into from
May 23, 2022
Merged

Conversation

isaacgsmith
Copy link
Member

Description

This creates new, in-depth documentation for the formal integral, and adds physics information to the formal integral docstrings.

How has this been tested?

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

Examples

The new documentation page:
https://smithis7.github.io/tardis/branch/formal_integral_doc/physics/spectrum/formal_integral.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.

@codecov
Copy link

codecov bot commented Mar 4, 2022

Codecov Report

Merging #1921 (976d447) into master (5d6e229) will increase coverage by 1.37%.
The diff coverage is 66.66%.

@@            Coverage Diff             @@
##           master    #1921      +/-   ##
==========================================
+ Coverage   58.76%   60.13%   +1.37%     
==========================================
  Files          70       70              
  Lines        7843     8108     +265     
==========================================
+ Hits         4609     4876     +267     
+ Misses       3234     3232       -2     
Impacted Files Coverage Δ
...dis/montecarlo/montecarlo_numba/formal_integral.py 53.87% <66.66%> (ø)
tardis/tardis/plasma/properties/nlte.py
...ontecarlo/montecarlo_numba/formal_integral_cuda.py
tardis/tardis/plasma/standard_plasmas.py
...s/tardis/montecarlo/montecarlo_numba/estimators.py
tardis/tardis/visualization/plot_util.py
tardis/tardis/io/util.py
tardis/tardis/montecarlo/montecarlo_numba/base.py
tardis/tardis/io/parsers/arepo.py
...dis/tardis/visualization/tools/convergence_plot.py
... and 131 more

📣 Codecov can now indicate which changes are the most critical in Pull Requests. Learn more

@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 force-pushed the formal_integral_doc branch from 03581a1 to 2fa30b5 Compare March 28, 2022 18:49
@review-notebook-app
Copy link

Check out this pull request on  ReviewNB

See visual diffs & provide feedback on Jupyter Notebooks.


Powered by ReviewNB

@isaacgsmith isaacgsmith marked this pull request as ready for review April 21, 2022 02:35
@andrewfullard andrewfullard requested review from Rodot- and removed request for jaladh-singhal and atharva-2001 May 16, 2022 14:10
@Rodot- Rodot- merged commit 9f6d855 into tardis-sn:master May 23, 2022
@isaacgsmith isaacgsmith deleted the formal_integral_doc branch July 12, 2022 21:18
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
Status: Done
Development

Successfully merging this pull request may close these issues.

4 participants