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 (8377615).
Here are the outputs produced.
Results can also be downloaded as artifacts here.
Summarised output:

2	E999	[ ] SyntaxError: Expected an expression
1	E701	[ ] Multiple statements on one line (colon)
1	W291	[*] Trailing whitespace

Complete output(might be large):

docs/physics/tardisgamma/index.rst:1:1: E999 SyntaxError: Expected an expression
docs/physics/tardisgamma/opacities.rst:1:1: E999 SyntaxError: Expected an expression
docs/physics/tardisgamma/opacities.rst:4:64: E701 Multiple statements on one line (colon)
docs/physics/tardisgamma/opacities.rst:8:263: W291 [*] Trailing whitespace
Found 4 errors.
[*] 1 fixable with the `--fix` option.

[codecov]

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 69.87%. Comparing base (763c11d) to head (8377615).

Additional details and impacted files

@@            Coverage Diff             @@
##           master    #2876      +/-   ##
==========================================
- Coverage   70.22%   69.87%   -0.36%     
==========================================
  Files         214      214              
  Lines       15981    15981              
==========================================
- Hits        11223    11166      -57     
- Misses       4758     4815      +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 (763c11d) and the latest commit (8377615).
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 [763c11dd] <master>   | After [8377615d]    | Ratio   | Benchmark (Parameter)                                                                                                               |
|----------|------------------------------|---------------------|---------|-------------------------------------------------------------------------------------------------------------------------------------|
|          | 1.16±0.08μs                  | 561±100ns           | ~0.48   | opacities_opacity.BenchmarkMontecarloMontecarloNumbaOpacities.time_pair_creation_opacity_calculation                                |
|          | 3.56±0.01ms                  | 3.88±0.04ms         | 1.09    | opacities_opacity_state.BenchmarkOpacitiesOpacityState.time_opacity_state_initialize('macroatom')                                   |
|          | 492±200ns                    | 521±200ns           | 1.06    | opacities_opacity.BenchmarkMontecarloMontecarloNumbaOpacities.time_compton_opacity_calculation                                      |
|          | 6.19±0.9μs                   | 6.51±0.6μs          | 1.05    | transport_montecarlo_vpacket.BenchmarkMontecarloMontecarloNumbaVpacket.time_trace_vpacket                                           |
|          | 1.49±0.4μs                   | 1.54±0.3μs          | 1.03    | transport_geometry_calculate_distances.BenchmarkTransportGeometryCalculateDistances.time_calculate_distance_line                    |
|          | 206±0.3ns                    | 211±0.1ns           | 1.02    | spectrum_formal_integral.BenchmarkTransportMontecarloFormalIntegral.time_intensity_black_body                                       |
|          | 1.18±0μs                     | 1.19±0μs            | 1.01    | transport_geometry_calculate_distances.BenchmarkTransportGeometryCalculateDistances.time_calculate_distance_boundary                |
|          | 43.9±30μs                    | 44.5±20μs           | 1.01    | transport_montecarlo_interaction.BenchmarkTransportMontecarloInteraction.time_line_scatter                                          |
|          | 2.07±0m                      | 2.07±0m             | 1.00    | spectrum_formal_integral.BenchmarkTransportMontecarloFormalIntegral.time_FormalIntegrator_functions                                 |
|          | 724±0.2ns                    | 727±0.5ns           | 1.00    | transport_montecarlo_interaction.BenchmarkTransportMontecarloInteraction.time_thomson_scatter                                       |
|          | 64.9±0.3ms                   | 65.0±0.1ms          | 1.00    | transport_montecarlo_packet_trackers.BenchmarkTransportMontecarloPacketTrackers.time_rpacket_trackers_to_dataframe                  |
|          | 1.06±0m                      | 1.05±0m             | 0.99    | run_tardis.BenchmarkRunTardis.time_run_tardis_rpacket_tracking                                                                      |
|          | 1.68±0.01ms                  | 1.66±0.01ms         | 0.99    | transport_montecarlo_main_loop.BenchmarkTransportMontecarloMontecarloMainLoop.time_montecarlo_main_loop                             |
|          | 20.9±5μs                     | 20.6±4μs            | 0.99    | transport_montecarlo_packet_trackers.BenchmarkTransportMontecarloPacketTrackers.time_generate_rpacket_last_interaction_tracker_list |
|          | 2.74±0.03ms                  | 2.69±0ms            | 0.98    | opacities_opacity_state.BenchmarkOpacitiesOpacityState.time_opacity_state_initialize('scatter')                                     |
|          | 40.0±0.07s                   | 39.3±0.05s          | 0.98    | run_tardis.BenchmarkRunTardis.time_run_tardis                                                                                       |
|          | 30.9±0.02μs                  | 30.4±0.05μs         | 0.98    | transport_montecarlo_packet_trackers.BenchmarkTransportMontecarloPacketTrackers.time_generate_rpacket_tracker_list                  |
|          | 2.55±0.4ms                   | 2.49±0.4ms          | 0.98    | transport_montecarlo_single_packet_loop.BenchmarkTransportMontecarloSinglePacketLoop.time_single_packet_loop                        |
|          | 7.71±2μs                     | 7.54±1μs            | 0.98    | transport_montecarlo_vpacket.BenchmarkMontecarloMontecarloNumbaVpacket.time_trace_vpacket_volley                                    |
|          | 3.47±0.5μs                   | 3.36±0.6μs          | 0.97    | transport_montecarlo_vpacket.BenchmarkMontecarloMontecarloNumbaVpacket.time_trace_vpacket_within_shell                              |
|          | 591±200ns                    | 561±200ns           | 0.95    | opacities_opacity.BenchmarkMontecarloMontecarloNumbaOpacities.time_photoabsorption_opacity_calculation                              |
|          | 2.97±0.6μs                   | 2.82±0.4μs          | 0.95    | transport_montecarlo_vpacket.BenchmarkMontecarloMontecarloNumbaVpacket.time_trace_bad_vpacket                                       |
|          | 2.08±1μs                     | 1.96±1μs            | 0.94    | transport_montecarlo_estimators_radfield_estimator_calcs.BenchmarkMontecarloMontecarloNumbaPacket.time_update_line_estimators       |
|          | 43.1±20μs                    | 39.3±20μs           | 0.91    | transport_montecarlo_interaction.BenchmarkTransportMontecarloInteraction.time_line_emission                                         |

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