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

Fixes indentation for tracking key to be nested under montecarlo key in YAML #2946

Merged
merged 7 commits into from
Jan 14, 2025

Conversation

Sonu0305
Copy link
Contributor

📝 Description

Type: 🪲 bugfix | 📝 documentation

Fixed indentation in docs\io\output\how_to_rpacket_tracking.ipynb to correct the structure of YAML,
i.e. the tracking key should be nested under montecarlo key.

Closes #2480

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

Copy link

Check out this pull request on  ReviewNB

See visual diffs & provide feedback on Jupyter Notebooks.


Powered by ReviewNB

@tardis-bot
Copy link
Contributor

tardis-bot commented Jan 13, 2025

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

1	W291	[*] Trailing whitespace

Complete output(might be large):

docs/io/output/how_to_rpacket_tracking.ipynb:cell 12:1:62: W291 [*] Trailing whitespace
Found 1 error.
[*] 1 fixable with the `--fix` option.

Copy link

codecov bot commented Jan 13, 2025

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 70.03%. Comparing base (2a06fdf) to head (5b7827a).
Report is 1 commits behind head on master.

Additional details and impacted files
@@            Coverage Diff             @@
##           master    #2946      +/-   ##
==========================================
- Coverage   70.39%   70.03%   -0.36%     
==========================================
  Files         222      222              
  Lines       16157    16157              
==========================================
- Hits        11373    11316      -57     
- Misses       4784     4841      +57     

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

@tardis-bot
Copy link
Contributor

*beep* *bop*

Hi, human.

The docs workflow has succeeded ✔️

Click here to see your results.

@tardis-bot
Copy link
Contributor

tardis-bot commented Jan 13, 2025

*beep* *bop*
Hi human,
I ran benchmarks as you asked comparing master (2a06fdf) and the latest commit (5b7827a).
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 [2a06fdfb] <master>   | After [5b7827a9]    | Ratio   | Benchmark (Parameter)                                                                                                               |
|----------|------------------------------|---------------------|---------|-------------------------------------------------------------------------------------------------------------------------------------|
|          | 3.12±0.6μs                   | 5.50±1μs            | ~1.77   | transport_montecarlo_vpacket.BenchmarkMontecarloMontecarloNumbaVpacket.time_trace_vpacket_within_shell                              |
|          | 41.9±30μs                    | 46.4±20μs           | ~1.11   | transport_montecarlo_interaction.BenchmarkTransportMontecarloInteraction.time_line_emission                                         |
|          | 1.77±0.3μs                   | 1.58±0.4μs          | ~0.89   | transport_geometry_calculate_distances.BenchmarkTransportGeometryCalculateDistances.time_calculate_distance_line                    |
|          | 55.1±30μs                    | 45.1±20μs           | ~0.82   | transport_montecarlo_interaction.BenchmarkTransportMontecarloInteraction.time_line_scatter                                          |
|          | 3.18±0.01ms                  | 2.56±0ms            | ~0.81   | opacities_opacity_state.BenchmarkOpacitiesOpacityState.time_opacity_state_initialize('scatter')                                     |
|          | 10.9±2μs                     | 6.41±0.6μs          | ~0.59   | transport_montecarlo_vpacket.BenchmarkMontecarloMontecarloNumbaVpacket.time_trace_vpacket                                           |
|          | 7.49±2μs                     | 8.02±2μs            | 1.07    | transport_montecarlo_vpacket.BenchmarkMontecarloMontecarloNumbaVpacket.time_trace_vpacket_volley                                    |
|          | 22.6±6μs                     | 24.0±6μs            | 1.06    | transport_montecarlo_packet_trackers.BenchmarkTransportMontecarloPacketTrackers.time_generate_rpacket_last_interaction_tracker_list |
|          | 731±0.9ns                    | 764±2ns             | 1.05    | transport_montecarlo_interaction.BenchmarkTransportMontecarloInteraction.time_thomson_scatter                                       |
|          | 611±100ns                    | 631±100ns           | 1.03    | opacities_opacity.BenchmarkMontecarloMontecarloNumbaOpacities.time_photoabsorption_opacity_calculation                              |
|          | 37.8±0.1μs                   | 38.8±0.03μs         | 1.03    | transport_montecarlo_packet_trackers.BenchmarkTransportMontecarloPacketTrackers.time_generate_rpacket_tracker_list                  |
|          | 2.53±0.4ms                   | 2.60±0.4ms          | 1.03    | transport_montecarlo_single_packet_loop.BenchmarkTransportMontecarloSinglePacketLoop.time_single_packet_loop                        |
|          | 1.18±0μs                     | 1.21±0μs            | 1.02    | transport_geometry_calculate_distances.BenchmarkTransportGeometryCalculateDistances.time_calculate_distance_boundary                |
|          | 2.09±0m                      | 2.08±0m             | 1.00    | spectrum_formal_integral.BenchmarkTransportMontecarloFormalIntegral.time_FormalIntegrator_functions                                 |
|          | 1.66±0.02ms                  | 1.66±0.01ms         | 1.00    | transport_montecarlo_main_loop.BenchmarkTransportMontecarloMontecarloMainLoop.time_montecarlo_main_loop                             |
|          | 39.0±0.2s                    | 38.5±0.01s          | 0.99    | run_tardis.BenchmarkRunTardis.time_run_tardis                                                                                       |
|          | 1.05±0m                      | 1.04±0m             | 0.99    | run_tardis.BenchmarkRunTardis.time_run_tardis_rpacket_tracking                                                                      |
|          | 208±0.3ns                    | 205±0.2ns           | 0.98    | spectrum_formal_integral.BenchmarkTransportMontecarloFormalIntegral.time_intensity_black_body                                       |
|          | 2.29±2μs                     | 2.22±2μs            | 0.97    | transport_montecarlo_estimators_radfield_estimator_calcs.BenchmarkMontecarloMontecarloNumbaPacket.time_update_line_estimators       |
|          | 65.3±0.1ms                   | 63.6±0.1ms          | 0.97    | transport_montecarlo_packet_trackers.BenchmarkTransportMontecarloPacketTrackers.time_rpacket_trackers_to_dataframe                  |
|          | 611±100ns                    | 581±200ns           | 0.95    | opacities_opacity.BenchmarkMontecarloMontecarloNumbaOpacities.time_pair_creation_opacity_calculation                                |
|          | 3.92±0.01ms                  | 3.74±0ms            | 0.95    | opacities_opacity_state.BenchmarkOpacitiesOpacityState.time_opacity_state_initialize('macroatom')                                   |
|          | 3.15±0.3μs                   | 3.00±0.4μs          | 0.95    | transport_montecarlo_vpacket.BenchmarkMontecarloMontecarloNumbaVpacket.time_trace_bad_vpacket                                       |
|          | 581±100ns                    | 531±100ns           | 0.91    | opacities_opacity.BenchmarkMontecarloMontecarloNumbaOpacities.time_compton_opacity_calculation                                      |

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

@Sonu0305
Copy link
Contributor Author

Hi @andrewfullard @atharva-2001 @jvshields ,
Could you please review when you have a chance, Thank You.

@jvshields jvshields merged commit 0a0ecbf into tardis-sn:master Jan 14, 2025
14 of 15 checks passed
@Sonu0305
Copy link
Contributor Author

Hi @andrewfullard ,
Can the GSoC label be applied to this PR too?
Thank you for helping.

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.

Small Bug on Documentation - Incorrect Indentation Inside YAML File
5 participants