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

Gamma ray documentation introduction #2858

Merged
merged 4 commits into from
Nov 4, 2024

Conversation

CePowers
Copy link
Contributor

📝 Description

Type:📝 documentation

I added an introduction for the gamma ray documentation that explains what the code can be used for and why it is relevant.

📌 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
Copy link
Contributor

tardis-bot commented Oct 15, 2024

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

1	E999	SyntaxError: Expected an expression

Complete output(might be large):

docs/physics/tardisgamma/index.rst:1:1: E999 SyntaxError: Expected an expression
Found 1 error.

Copy link

codecov bot commented Oct 15, 2024

Codecov Report

All modified and coverable lines are covered by tests ✅

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

Additional details and impacted files
@@            Coverage Diff             @@
##           master    #2858      +/-   ##
==========================================
- 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
Copy link
Contributor

tardis-bot commented Oct 15, 2024

*beep* *bop*

Hi, human.

The docs workflow has succeeded ✔️

Click here to see your results.

@tardis-bot
Copy link
Contributor

tardis-bot commented Oct 15, 2024

*beep* *bop*
Hi human,
I ran benchmarks as you asked comparing master (5f11626) and the latest commit (b17e0d4).
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 [5f116263] <master>   | After [b17e0d45]    | Ratio   | Benchmark (Parameter)                                                                                                               |
|----------|------------------------------|---------------------|---------|-------------------------------------------------------------------------------------------------------------------------------------|
|          | 2.77±0.6μs                   | 3.74±0.5μs          | ~1.35   | transport_montecarlo_vpacket.BenchmarkMontecarloMontecarloNumbaVpacket.time_trace_bad_vpacket                                       |
|          | 2.71±0.02ms                  | 3.10±0.04ms         | ~1.14   | opacities_opacity_state.BenchmarkOpacitiesOpacityState.time_opacity_state_initialize('scatter')                                     |
|          | 2.62±1μs                     | 2.31±1μs            | ~0.88   | transport_montecarlo_estimators_radfield_estimator_calcs.BenchmarkMontecarloMontecarloNumbaPacket.time_update_line_estimators       |
|          | 37.6±10μs                    | 31.5±9μs            | ~0.84   | transport_montecarlo_packet_trackers.BenchmarkTransportMontecarloPacketTrackers.time_generate_rpacket_last_interaction_tracker_list |
|          | 8.94±2μs                     | 7.44±1μs            | ~0.83   | transport_montecarlo_vpacket.BenchmarkMontecarloMontecarloNumbaVpacket.time_trace_vpacket_volley                                    |
|          | 61.0±50μs                    | 43.3±40μs           | ~0.71   | transport_montecarlo_interaction.BenchmarkTransportMontecarloInteraction.time_line_emission                                         |
|          | 561±200ns                    | 610±200ns           | 1.09    | opacities_opacity.BenchmarkMontecarloMontecarloNumbaOpacities.time_photoabsorption_opacity_calculation                              |
|          | 1.79±0.01ms                  | 1.86±0.02ms         | 1.04    | transport_montecarlo_main_loop.BenchmarkTransportMontecarloMontecarloMainLoop.time_montecarlo_main_loop                             |
|          | 1.05±0m                      | 1.08±0m             | 1.03    | run_tardis.BenchmarkRunTardis.time_run_tardis_rpacket_tracking                                                                      |
|          | 1.19±0μs                     | 1.21±0μs            | 1.02    | transport_geometry_calculate_distances.BenchmarkTransportGeometryCalculateDistances.time_calculate_distance_boundary                |
|          | 67.6±0.7ms                   | 69.2±0.08ms         | 1.02    | transport_montecarlo_packet_trackers.BenchmarkTransportMontecarloPacketTrackers.time_rpacket_trackers_to_dataframe                  |
|          | 40.9±0.08s                   | 40.8±0.2s           | 1.00    | run_tardis.BenchmarkRunTardis.time_run_tardis                                                                                       |
|          | 718±0.2ns                    | 719±0.5ns           | 1.00    | transport_montecarlo_interaction.BenchmarkTransportMontecarloInteraction.time_thomson_scatter                                       |
|          | 6.10±1μs                     | 6.07±1μs            | 1.00    | transport_montecarlo_vpacket.BenchmarkMontecarloMontecarloNumbaVpacket.time_trace_vpacket                                           |
|          | 2.14±0m                      | 2.12±0.01m          | 0.99    | spectrum_formal_integral.BenchmarkTransportMontecarloFormalIntegral.time_FormalIntegrator_functions                                 |
|          | 206±0.09ns                   | 203±0.1ns           | 0.99    | spectrum_formal_integral.BenchmarkTransportMontecarloFormalIntegral.time_intensity_black_body                                       |
|          | 46.1±40μs                    | 45.4±40μs           | 0.98    | transport_montecarlo_interaction.BenchmarkTransportMontecarloInteraction.time_line_scatter                                          |
|          | 541±200ns                    | 521±200ns           | 0.96    | opacities_opacity.BenchmarkMontecarloMontecarloNumbaOpacities.time_compton_opacity_calculation                                      |
|          | 2.80±0.5ms                   | 2.69±0.4ms          | 0.96    | transport_montecarlo_single_packet_loop.BenchmarkTransportMontecarloSinglePacketLoop.time_single_packet_loop                        |
|          | 581±100ns                    | 551±200ns           | 0.95    | opacities_opacity.BenchmarkMontecarloMontecarloNumbaOpacities.time_pair_creation_opacity_calculation                                |
|          | 4.18±0.01ms                  | 3.97±0.01ms         | 0.95    | opacities_opacity_state.BenchmarkOpacitiesOpacityState.time_opacity_state_initialize('macroatom')                                   |
|          | 32.6±0.01μs                  | 30.8±0.02μs         | 0.95    | transport_montecarlo_packet_trackers.BenchmarkTransportMontecarloPacketTrackers.time_generate_rpacket_tracker_list                  |
|          | 1.70±0.4μs                   | 1.57±0.4μs          | 0.92    | transport_geometry_calculate_distances.BenchmarkTransportGeometryCalculateDistances.time_calculate_distance_line                    |
|          | 3.49±0.9μs                   | 3.19±0.7μs          | 0.91    | transport_montecarlo_vpacket.BenchmarkMontecarloMontecarloNumbaVpacket.time_trace_vpacket_within_shell                              |

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

andrewfullard
andrewfullard previously approved these changes Oct 28, 2024
@Knights-Templars Knights-Templars enabled auto-merge (squash) November 4, 2024 15:07
***************************
This code module simulates the propagation of :math:`\gamma`-ray photons through the ejecta and can be used to study high energy phenomenon within the ejecta as well as the energy deposition of :math:`\gamma`-rays and positrons.

Type Ia supernovae produce a large amount of energy from :math:`\gamma`-rays produced from the radioactive decay of :sup:`56` Ni and :sup:`56` Co. These photons often are not able to escape the ejecta until later times in the supernova when the density decreases. Once the :math:`\gamma`-rays are able to escape they can provide information about the mass and distribution of radioactive isotopes created in the supernova.
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Early on the ejecta is so dense that essentially no gamma-ray escape the ejecta. As the supernova expands, the density drops and more and more gamma rays can escape. Once ....

@Knights-Templars Knights-Templars merged commit a1f621f into tardis-sn:master Nov 4, 2024
14 of 15 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

6 participants