Estimators and Convergence Documentation

[isaacgsmith]

Description

This adds interactive documentation for estimators and documentation about how TARDIS handles convergence.

How has this been tested?

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

Examples

The pages I made are the two subpages here:
https://smithis7.github.io/tardis/branch/est_conv_doc/physics/est_and_conv/index.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]

Check out this pull request on 

See visual diffs & provide feedback on Jupyter Notebooks.

---

Powered by ReviewNB

[tardis-bot]

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.

[tardis-bot]

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.

[codecov]

Codecov Report

Merging #1920 (dccca67) into master (f541e73) will increase coverage by 0.01%.
The diff coverage is n/a.

@@            Coverage Diff             @@
##           master    #1920      +/-   ##
==========================================
+ Coverage   58.74%   58.76%   +0.01%     
==========================================
  Files          70       70              
  Lines        7847     7843       -4     
==========================================
- Hits         4610     4609       -1     
+ Misses       3237     3234       -3     

Impacted Files	Coverage Δ
...rdis/plasma/properties/transition_probabilities.py	24.03% <0.00%> (ø)
...s/tardis/montecarlo/montecarlo_numba/estimators.py	34.61% <0.00%> (+0.13%)	⬆️
.../montecarlo/montecarlo_numba/r_packet_transport.py	16.88% <0.00%> (+0.21%)	⬆️

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

[isaacgsmith]

@andrewfullard I did all of your suggestions except for the last one about using the nu_bar symbol. I am trying to separate the concepts of $\bar{\nu}$ (imagine LaTeX -- this is the actual mean frequency quantity) and the nu_bar estimator, which is purely a numerical/computational quantity that is used to calculate $\bar{\nu}$. If you still think I should use the symbol I can but that's my explanation.