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

Moved gamma ray notebook to docs #2930

Open
wants to merge 1 commit into
base: master
Choose a base branch
from

Conversation

kavya-r30
Copy link

📝 Description

Type: 📝 documentation

Write a complete description of your changes, including the necessary context or any piece of information required to understand your work.

Changed file path of gamma ray notebook /tardis/energy_input/docs to /docs/contributing/in_progress/nebular_phase
as referenced in #2670

Also, link issues affected by this pull request by using the keywords: close, closes, closed, fix, fixes, fixed, resolve, resolves or resolved.
fixes: #2766

📌 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 Jan 8, 2025

*beep* *bop*

Hi, human.

The docs workflow has succeeded ✔️

Click here to see your results.

@tardis-bot
Copy link
Contributor

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

4	W291	[*] Trailing whitespace
3	F401	[*] `astropy.constants` imported but unused
2	I001	[*] Import block is un-sorted or un-formatted
1	W605	[*] Invalid escape sequence: `\g`

Complete output(might be large):

docs/contributing/in_progress/nebular_phase/working_gamma_ray_test.ipynb:cell 1:2:1: I001 [*] Import block is un-sorted or un-formatted
docs/contributing/in_progress/nebular_phase/working_gamma_ray_test.ipynb:cell 1:3:18: F401 [*] `pandas` imported but unused
docs/contributing/in_progress/nebular_phase/working_gamma_ray_test.ipynb:cell 1:6:29: F401 [*] `astropy.constants` imported but unused
docs/contributing/in_progress/nebular_phase/working_gamma_ray_test.ipynb:cell 1:7:25: F401 [*] `astropy.units` imported but unused
docs/contributing/in_progress/nebular_phase/working_gamma_ray_test.ipynb:cell 2:2:1: I001 [*] Import block is un-sorted or un-formatted
docs/contributing/in_progress/nebular_phase/working_gamma_ray_test.ipynb:cell 7:5:70: W291 [*] Trailing whitespace
docs/contributing/in_progress/nebular_phase/working_gamma_ray_test.ipynb:cell 9:3:96: W291 [*] Trailing whitespace
docs/contributing/in_progress/nebular_phase/working_gamma_ray_test.ipynb:cell 9:4:99: W291 [*] Trailing whitespace
docs/contributing/in_progress/nebular_phase/working_gamma_ray_test.ipynb:cell 9:6:78: W291 [*] Trailing whitespace
docs/contributing/in_progress/nebular_phase/working_gamma_ray_test.ipynb:cell 10:2:65: W605 [*] Invalid escape sequence: `\g`
Found 10 errors.
[*] 10 fixable with the `--fix` option.

@tardis-bot
Copy link
Contributor

tardis-bot commented Jan 8, 2025

*beep* *bop*
Hi human,
I ran benchmarks as you asked comparing master (7e37d5f) and the latest commit (eba9646).
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 [5e2d0bb3] <master>   | After [eba96462]    | Ratio   | Benchmark (Parameter)                                                                                                               |
|----------|------------------------------|---------------------|---------|-------------------------------------------------------------------------------------------------------------------------------------|
|          | 26.7±7μs                     | 46.9±20μs           | ~1.76   | transport_montecarlo_packet_trackers.BenchmarkTransportMontecarloPacketTrackers.time_generate_rpacket_last_interaction_tracker_list |
|          | 7.42±2μs                     | 8.54±2μs            | ~1.15   | transport_montecarlo_vpacket.BenchmarkMontecarloMontecarloNumbaVpacket.time_trace_vpacket_volley                                    |
|          | 1.77±0.01ms                  | 2.00±0.02ms         | ~1.13   | transport_montecarlo_main_loop.BenchmarkTransportMontecarloMontecarloMainLoop.time_montecarlo_main_loop                             |
|          | 6.81±1μs                     | 7.51±0.3μs          | ~1.10   | transport_montecarlo_vpacket.BenchmarkMontecarloMontecarloNumbaVpacket.time_trace_vpacket                                           |
|          | 3.81±0.4μs                   | 3.43±0.3μs          | ~0.90   | transport_montecarlo_vpacket.BenchmarkMontecarloMontecarloNumbaVpacket.time_trace_bad_vpacket                                       |
|          | 65.8±40μs                    | 46.2±50μs           | ~0.70   | transport_montecarlo_interaction.BenchmarkTransportMontecarloInteraction.time_line_scatter                                          |
|          | 4.65±0.01ms                  | 5.07±0.4ms          | 1.09    | opacities_opacity_state.BenchmarkOpacitiesOpacityState.time_opacity_state_initialize('macroatom')                                   |
|          | 610±200ns                    | 631±200ns           | 1.03    | opacities_opacity.BenchmarkMontecarloMontecarloNumbaOpacities.time_photoabsorption_opacity_calculation                              |
|          | 726±2ns                      | 751±1ns             | 1.03    | transport_montecarlo_interaction.BenchmarkTransportMontecarloInteraction.time_thomson_scatter                                       |
|          | 581±100ns                    | 592±200ns           | 1.02    | opacities_opacity.BenchmarkMontecarloMontecarloNumbaOpacities.time_compton_opacity_calculation                                      |
|          | 66.1±0.1ms                   | 67.5±0.01ms         | 1.02    | transport_montecarlo_packet_trackers.BenchmarkTransportMontecarloPacketTrackers.time_rpacket_trackers_to_dataframe                  |
|          | 2.85±0.5ms                   | 2.91±0.4ms          | 1.02    | transport_montecarlo_single_packet_loop.BenchmarkTransportMontecarloSinglePacketLoop.time_single_packet_loop                        |
|          | 41.3±0.02s                   | 41.8±0.1s           | 1.01    | run_tardis.BenchmarkRunTardis.time_run_tardis                                                                                       |
|          | 1.09±0m                      | 1.11±0m             | 1.01    | run_tardis.BenchmarkRunTardis.time_run_tardis_rpacket_tracking                                                                      |
|          | 2.15±0m                      | 2.15±0m             | 1.00    | spectrum_formal_integral.BenchmarkTransportMontecarloFormalIntegral.time_FormalIntegrator_functions                                 |
|          | 206±0.1ns                    | 206±0.1ns           | 1.00    | spectrum_formal_integral.BenchmarkTransportMontecarloFormalIntegral.time_intensity_black_body                                       |
|          | 1.22±0μs                     | 1.21±0μs            | 0.99    | transport_geometry_calculate_distances.BenchmarkTransportGeometryCalculateDistances.time_calculate_distance_boundary                |
|          | 581±100ns                    | 572±200ns           | 0.98    | opacities_opacity.BenchmarkMontecarloMontecarloNumbaOpacities.time_pair_creation_opacity_calculation                                |
|          | 3.64±0.4μs                   | 3.53±0.5μs          | 0.97    | transport_montecarlo_vpacket.BenchmarkMontecarloMontecarloNumbaVpacket.time_trace_vpacket_within_shell                              |
|          | 54.1±40μs                    | 51.8±40μs           | 0.96    | transport_montecarlo_interaction.BenchmarkTransportMontecarloInteraction.time_line_emission                                         |
|          | 40.8±0.5μs                   | 39.1±0.2μs          | 0.96    | transport_montecarlo_packet_trackers.BenchmarkTransportMontecarloPacketTrackers.time_generate_rpacket_tracker_list                  |
|          | 3.88±0.04ms                  | 3.62±0.02ms         | 0.93    | opacities_opacity_state.BenchmarkOpacitiesOpacityState.time_opacity_state_initialize('scatter')                                     |
|          | 1.72±0.3μs                   | 1.58±0.4μs          | 0.92    | transport_geometry_calculate_distances.BenchmarkTransportGeometryCalculateDistances.time_calculate_distance_line                    |
|          | 2.52±3μs                     | 2.31±3μs            | 0.92    | transport_montecarlo_estimators_radfield_estimator_calcs.BenchmarkMontecarloMontecarloNumbaPacket.time_update_line_estimators       |

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

@andrewfullard
Copy link
Contributor

Hello! Are you planning to apply to Google Summer of Code?

@kavya-r30
Copy link
Author

Hello! Thank you for asking. Yes, I am planning to apply for Google Summer of Code. I am very excited about the opportunity to contribute to Tardis. Please let me know if you have any advice or suggestions!

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.

3 participants