Gammaray opacity documentation

[CePowers]

📝 Description

Type: 📝 documentation `

I started a new documentation file for the sources of opacity for gamma rays. I added information for Compton Scattering with plans to add other sources of opacity.

📌 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.

[tardis-bot]

*beep* *bop*
Hi human,
I ran ruff on the latest commit (765181a).
Here are the outputs produced.
Results can also be downloaded as artifacts here.
Summarised output:

11	W191	[ ] Indentation contains tabs
5	E902	[ ] stream did not contain valid UTF-8
5	W291	[*] Trailing whitespace
2	E999	[ ] SyntaxError: Expected a statement
1	I001	[*] Import block is un-sorted or un-formatted

Complete output(might be large):

docs/physics/tardisgamma/images/all_coeffs.png:1:1: E902 stream did not contain valid UTF-8
docs/physics/tardisgamma/images/coeff_fractions.png:1:1: E902 stream did not contain valid UTF-8
docs/physics/tardisgamma/images/compton_scattering_coefficient.png:1:1: E902 stream did not contain valid UTF-8
docs/physics/tardisgamma/images/pair_production_coefficient.png:1:1: E902 stream did not contain valid UTF-8
docs/physics/tardisgamma/images/photoabsorption_coefficient.png:1:1: E902 stream did not contain valid UTF-8
docs/physics/tardisgamma/index.rst:1:1: E999 SyntaxError: Expected an expression
docs/physics/tardisgamma/opacities.ipynb:cell 2:1:1: I001 [*] Import block is un-sorted or un-formatted
docs/physics/tardisgamma/opacities.ipynb:cell 7:5:31: W291 [*] Trailing whitespace
docs/tardis.bib:1:1: E999 SyntaxError: Expected a statement
docs/tardis.bib:308:1: W191 Indentation contains tabs
docs/tardis.bib:309:1: W191 Indentation contains tabs
docs/tardis.bib:310:1: W191 Indentation contains tabs
docs/tardis.bib:311:1: W191 Indentation contains tabs
docs/tardis.bib:312:1: W191 Indentation contains tabs
docs/tardis.bib:313:1: W191 Indentation contains tabs
docs/tardis.bib:314:1: W191 Indentation contains tabs
docs/tardis.bib:315:1: W191 Indentation contains tabs
docs/tardis.bib:316:1: W191 Indentation contains tabs
docs/tardis.bib:317:1: W191 Indentation contains tabs
docs/tardis.bib:318:1: W191 Indentation contains tabs
docs/tardis.bib:352:22: W291 [*] Trailing whitespace
docs/tardis.bib:355:23: W291 [*] Trailing whitespace
docs/tardis.bib:356:30: W291 [*] Trailing whitespace
docs/tardis.bib:358:2: W291 [*] Trailing whitespace
Found 24 errors.
[*] 6 fixable with the `--fix` option.

[codecov]

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 69.66%. Comparing base (a51af90) to head (765181a).

Additional details and impacted files

@@            Coverage Diff             @@
##           master    #2876      +/-   ##
==========================================
- Coverage   70.01%   69.66%   -0.35%     
==========================================
  Files         228      228              
  Lines       16549    16549              
==========================================
- Hits        11586    11529      -57     
- Misses       4963     5020      +57     

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

[tardis-bot]

*beep* *bop*

Hi, human.

The docs workflow has succeeded ✔️

Click here to see your results.

[tardis-bot]

*beep* *bop*
Hi human,
I ran benchmarks as you asked comparing master (a51af90) and the latest commit (765181a).
Here are the logs produced by ASV.
Results can also be downloaded as artifacts here.

Significantly changed benchmarks:

All benchmarks:

Benchmarks that have stayed the same:

| Change   | Before [a51af908] <master>   | After [765181aa]    | Ratio   | Benchmark (Parameter)                                                                                                               |
|----------|------------------------------|---------------------|---------|-------------------------------------------------------------------------------------------------------------------------------------|
|          | 591±100ns                    | 772±100ns           | ~1.31   | opacities_opacity.BenchmarkMontecarloMontecarloNumbaOpacities.time_pair_creation_opacity_calculation                                |
|          | 1.39±0.3μs                   | 1.70±0.1μs          | ~1.22   | transport_geometry_calculate_distances.BenchmarkTransportGeometryCalculateDistances.time_calculate_distance_line                    |
|          | 7.42±2μs                     | 9.01±2μs            | ~1.21   | transport_montecarlo_vpacket.BenchmarkMontecarloMontecarloNumbaVpacket.time_trace_vpacket_volley                                    |
|          | 2.14±1μs                     | 2.39±1μs            | ~1.12   | transport_montecarlo_estimators_radfield_estimator_calcs.BenchmarkMontecarloMontecarloNumbaPacket.time_update_line_estimators       |
|          | 621±200ns                    | 561±100ns           | ~0.90   | opacities_opacity.BenchmarkMontecarloMontecarloNumbaOpacities.time_photoabsorption_opacity_calculation                              |
|          | 3.41±0.4μs                   | 3.06±0.7μs          | ~0.90   | transport_montecarlo_vpacket.BenchmarkMontecarloMontecarloNumbaVpacket.time_trace_bad_vpacket                                       |
|          | 611±80ns                     | 530±100ns           | ~0.87   | opacities_opacity.BenchmarkMontecarloMontecarloNumbaOpacities.time_compton_opacity_calculation                                      |
|          | 4.41±0.07ms                  | 3.80±0.06ms         | ~0.86   | opacities_opacity_state.BenchmarkOpacitiesOpacityState.time_opacity_state_initialize('macroatom')                                   |
|          | 36.6±10μs                    | 24.8±6μs            | ~0.68   | transport_montecarlo_packet_trackers.BenchmarkTransportMontecarloPacketTrackers.time_generate_rpacket_last_interaction_tracker_list |
|          | 3.15±0.7μs                   | 3.45±0.2μs          | 1.10    | transport_montecarlo_vpacket.BenchmarkMontecarloMontecarloNumbaVpacket.time_trace_vpacket_within_shell                              |
|          | 39.9±20μs                    | 41.8±20μs           | 1.05    | transport_montecarlo_interaction.BenchmarkTransportMontecarloInteraction.time_line_emission                                         |
|          | 1.18±0μs                     | 1.22±0μs            | 1.03    | transport_geometry_calculate_distances.BenchmarkTransportGeometryCalculateDistances.time_calculate_distance_boundary                |
|          | 5.95±1μs                     | 6.13±1μs            | 1.03    | transport_montecarlo_vpacket.BenchmarkMontecarloMontecarloNumbaVpacket.time_trace_vpacket                                           |
|          | 50.2±30μs                    | 51.4±40μs           | 1.02    | transport_montecarlo_interaction.BenchmarkTransportMontecarloInteraction.time_line_scatter                                          |
|          | 2.09±0m                      | 2.10±0m             | 1.01    | spectrum_formal_integral.BenchmarkTransportMontecarloFormalIntegral.time_FormalIntegrator_functions                                 |
|          | 726±10ns                     | 735±1ns             | 1.01    | transport_montecarlo_interaction.BenchmarkTransportMontecarloInteraction.time_thomson_scatter                                       |
|          | 39.7±0.05s                   | 39.9±0.09s          | 1.00    | run_tardis.BenchmarkRunTardis.time_run_tardis                                                                                       |
|          | 1.07±0m                      | 1.07±0m             | 1.00    | run_tardis.BenchmarkRunTardis.time_run_tardis_rpacket_tracking                                                                      |
|          | 67.9±0.3ms                   | 67.6±0.5ms          | 1.00    | transport_montecarlo_packet_trackers.BenchmarkTransportMontecarloPacketTrackers.time_rpacket_trackers_to_dataframe                  |
|          | 38.7±0.02μs                  | 38.3±0.03μs         | 0.99    | transport_montecarlo_packet_trackers.BenchmarkTransportMontecarloPacketTrackers.time_generate_rpacket_tracker_list                  |
|          | 210±0.2ns                    | 205±0.01ns          | 0.98    | spectrum_formal_integral.BenchmarkTransportMontecarloFormalIntegral.time_intensity_black_body                                       |
|          | 1.80±0.01ms                  | 1.65±0.01ms         | 0.92    | transport_montecarlo_main_loop.BenchmarkTransportMontecarloMontecarloMainLoop.time_montecarlo_main_loop                             |
|          | 2.96±0.6ms                   | 2.72±0.5ms          | 0.92    | transport_montecarlo_single_packet_loop.BenchmarkTransportMontecarloSinglePacketLoop.time_single_packet_loop                        |
|          | 3.07±0.08ms                  | 2.80±0.02ms         | 0.91    | opacities_opacity_state.BenchmarkOpacitiesOpacityState.time_opacity_state_initialize('scatter')                                     |

If you want to see the graph of the results, you can check it here

[andrewfullard]

Would like to see units on the y-axis of each plot

[jvshields]

I think that this would be a lot more informative if all the different opacities were plotted together so you could more easily compare which opacity matters in which range. The text is fine and looks good, but I would definitely like to see the plots merged.

[review-notebook-app]

Check out this pull request on 

See visual diffs & provide feedback on Jupyter Notebooks.

---

Powered by ReviewNB

[wkerzendorf]

very nice. Please add some citations and we might want to shift the formulas around in the opacities notebook. @Knights-Templars will know!

[Knights-Templars]

The citations still don't work. Also, please add citations for other opacities also (photo-absorption, compton).