Gamma decay energy documentation

[CePowers]

📝 Description

Type: 📝 documentation

Created a new file to explain how much energy comes from the radioactive decay that produces gamma rays.

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

[review-notebook-app]

Check out this pull request on 

See visual diffs & provide feedback on Jupyter Notebooks.

---

Powered by ReviewNB

[tardis-bot]

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

11	W191	[ ] Indentation contains tabs
2	E999	[ ] SyntaxError: Expected a statement
2	F401	[*] `astropy.constants` imported but unused
1	I001	[*] Import block is un-sorted or un-formatted
1	W291	[*] Trailing whitespace
1	W292	[*] No newline at end of file

Complete output(might be large):

docs/physics/tardisgamma/decayenergy.ipynb:cell 4:1:1: I001 [*] Import block is un-sorted or un-formatted
docs/physics/tardisgamma/decayenergy.ipynb:cell 4:2:30: F401 [*] `astropy.units` imported but unused
docs/physics/tardisgamma/decayenergy.ipynb:cell 4:3:34: F401 [*] `astropy.constants` imported but unused
docs/physics/tardisgamma/decayenergy.ipynb:cell 8:4:11: W291 [*] Trailing whitespace
docs/physics/tardisgamma/index.rst:1:1: E999 SyntaxError: Expected an expression
docs/physics/tardisgamma/index.rst:8:16: W292 [*] No newline at end of file
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
Found 18 errors.
[*] 5 fixable with the `--fix` option.

[codecov]

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 69.60%. Comparing base (5f11626) to head (6589a23).
Report is 1 commits behind head on master.

Additional details and impacted files

@@            Coverage Diff             @@
##           master    #2866      +/-   ##
==========================================
- Coverage   69.97%   69.60%   -0.38%     
==========================================
  Files         216      216              
  Lines       16077    16077              
==========================================
- Hits        11250    11190      -60     
- Misses       4827     4887      +60     

☔ 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 (6e5ae60) and the latest commit (54c42cb).
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 [6e5ae60d] <master>   | After [54c42cb2]    | Ratio   | Benchmark (Parameter)                                                                                                               |
|----------|------------------------------|---------------------|---------|-------------------------------------------------------------------------------------------------------------------------------------|
|          | 3.13±0.5μs                   | 3.63±0.7μs          | ~1.16   | transport_montecarlo_vpacket.BenchmarkMontecarloMontecarloNumbaVpacket.time_trace_vpacket_within_shell                              |
|          | 621±100ns                    | 561±200ns           | ~0.90   | opacities_opacity.BenchmarkMontecarloMontecarloNumbaOpacities.time_photoabsorption_opacity_calculation                              |
|          | 7.71±2μs                     | 6.95±2μs            | ~0.90   | transport_montecarlo_vpacket.BenchmarkMontecarloMontecarloNumbaVpacket.time_trace_vpacket_volley                                    |
|          | 6.95±1μs                     | 6.18±1μs            | ~0.89   | transport_montecarlo_vpacket.BenchmarkMontecarloMontecarloNumbaVpacket.time_trace_vpacket                                           |
|          | 55.3±30μs                    | 43.9±30μs           | ~0.79   | transport_montecarlo_interaction.BenchmarkTransportMontecarloInteraction.time_line_scatter                                          |
|          | 3.62±0.7μs                   | 2.66±0.6μs          | ~0.73   | transport_montecarlo_vpacket.BenchmarkMontecarloMontecarloNumbaVpacket.time_trace_bad_vpacket                                       |
|          | 20.4±5μs                     | 22.0±6μs            | 1.08    | transport_montecarlo_packet_trackers.BenchmarkTransportMontecarloPacketTrackers.time_generate_rpacket_last_interaction_tracker_list |
|          | 501±100ns                    | 521±100ns           | 1.04    | opacities_opacity.BenchmarkMontecarloMontecarloNumbaOpacities.time_compton_opacity_calculation                                      |
|          | 40.8±20μs                    | 42.1±20μs           | 1.03    | transport_montecarlo_interaction.BenchmarkTransportMontecarloInteraction.time_line_emission                                         |
|          | 63.3±0.01ms                  | 63.8±0.1ms          | 1.01    | transport_montecarlo_packet_trackers.BenchmarkTransportMontecarloPacketTrackers.time_rpacket_trackers_to_dataframe                  |
|          | 552±200ns                    | 551±200ns           | 1.00    | opacities_opacity.BenchmarkMontecarloMontecarloNumbaOpacities.time_pair_creation_opacity_calculation                                |
|          | 3.68±0.05ms                  | 3.68±0.01ms         | 1.00    | opacities_opacity_state.BenchmarkOpacitiesOpacityState.time_opacity_state_initialize('macroatom')                                   |
|          | 40.1±0.05s                   | 40.3±0s             | 1.00    | run_tardis.BenchmarkRunTardis.time_run_tardis                                                                                       |
|          | 1.06±0m                      | 1.06±0m             | 1.00    | run_tardis.BenchmarkRunTardis.time_run_tardis_rpacket_tracking                                                                      |
|          | 2.07±0m                      | 2.07±0m             | 1.00    | spectrum_formal_integral.BenchmarkTransportMontecarloFormalIntegral.time_FormalIntegrator_functions                                 |
|          | 206±1ns                      | 205±0.09ns          | 1.00    | spectrum_formal_integral.BenchmarkTransportMontecarloFormalIntegral.time_intensity_black_body                                       |
|          | 2.72±0.4ms                   | 2.71±0.4ms          | 1.00    | transport_montecarlo_single_packet_loop.BenchmarkTransportMontecarloSinglePacketLoop.time_single_packet_loop                        |
|          | 1.22±0μs                     | 1.20±0μs            | 0.99    | transport_geometry_calculate_distances.BenchmarkTransportGeometryCalculateDistances.time_calculate_distance_boundary                |
|          | 736±0.6ns                    | 727±0.6ns           | 0.99    | transport_montecarlo_interaction.BenchmarkTransportMontecarloInteraction.time_thomson_scatter                                       |
|          | 1.71±0.02ms                  | 1.69±0.01ms         | 0.99    | transport_montecarlo_main_loop.BenchmarkTransportMontecarloMontecarloMainLoop.time_montecarlo_main_loop                             |
|          | 2.82±0.01ms                  | 2.74±0ms            | 0.97    | opacities_opacity_state.BenchmarkOpacitiesOpacityState.time_opacity_state_initialize('scatter')                                     |
|          | 2.19±1μs                     | 2.06±1μs            | 0.94    | transport_montecarlo_estimators_radfield_estimator_calcs.BenchmarkMontecarloMontecarloNumbaPacket.time_update_line_estimators       |
|          | 32.8±0.07μs                  | 30.6±0.1μs          | 0.93    | transport_montecarlo_packet_trackers.BenchmarkTransportMontecarloPacketTrackers.time_generate_rpacket_tracker_list                  |
|          | 1.52±0.4μs                   | 1.39±0.4μs          | 0.91    | transport_geometry_calculate_distances.BenchmarkTransportGeometryCalculateDistances.time_calculate_distance_line                    |

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

[jvshields]

I think we want to use the gamma symbol with \gamma rather than type out gamma? Probably \gamma-rays

[CePowers]

I changed the typed out gammas to the gamma symbol.