-
-
Notifications
You must be signed in to change notification settings - Fork 405
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
New Gammaray Packet Initialization Documentation #2836
New Gammaray Packet Initialization Documentation #2836
Conversation
*beep* *bop* 6 W291 [*] Trailing whitespace
3 E999 [ ] SyntaxError: Expected a statement
3 W293 [*] Blank line contains whitespace
1 W292 [*] No newline at end of file
Complete output(might be large): docs/index.rst:1:1: E999 SyntaxError: Expected a statement
docs/index.rst:21:51: W291 [*] Trailing whitespace
docs/index.rst:43:76: W291 [*] Trailing whitespace
docs/index.rst:44:64: W291 [*] Trailing whitespace
docs/index.rst:45:71: W291 [*] Trailing whitespace
docs/index.rst:46:69: W291 [*] Trailing whitespace
docs/index.rst:47:68: W291 [*] Trailing whitespace
docs/index.rst:66:1: W293 [*] Blank line contains whitespace
docs/index.rst:79:1: W293 [*] Blank line contains whitespace
docs/index.rst:103:1: W293 [*] Blank line contains whitespace
docs/physics/tardisgamma/index.rst:1:1: E999 SyntaxError: Expected an expression
docs/physics/tardisgamma/packetinitialization.rst:1:8: E999 SyntaxError: Simple statements must be separated by newlines or semicolons
docs/physics/tardisgamma/packetinitialization.rst:32:22: W292 [*] No newline at end of file
Found 13 errors.
[*] 10 fixable with the `--fix` option.
|
Codecov ReportAll modified and coverable lines are covered by tests ✅
Additional details and impacted files@@ Coverage Diff @@
## master #2836 +/- ##
==========================================
- Coverage 70.87% 70.51% -0.37%
==========================================
Files 209 209
Lines 15589 15589
==========================================
- Hits 11049 10992 -57
- Misses 4540 4597 +57 ☔ View full report in Codecov by Sentry. |
*beep* *bop* Hi, human. The Click here to see your results. |
*beep* *bop* Significantly changed benchmarks: All benchmarks: Benchmarks that have stayed the same:
| Change | Before [43413319] <master> | After [857b3971] | Ratio | Benchmark (Parameter) |
|----------|------------------------------|---------------------|---------|-------------------------------------------------------------------------------------------------------------------------------------|
| | 6.52±1μs | 8.62±2μs | ~1.32 | transport_montecarlo_vpacket.BenchmarkMontecarloMontecarloNumbaVpacket.time_trace_vpacket |
| | 2.57±0.01ms | 3.26±0.03ms | ~1.27 | opacities_opacity_state.BenchmarkOpacitiesOpacityState.time_opacity_state_initialize('scatter') |
| | 3.57±0.03ms | 4.36±0.04ms | ~1.22 | opacities_opacity_state.BenchmarkOpacitiesOpacityState.time_opacity_state_initialize('macroatom') |
| | 2.82±0.7μs | 3.12±0.4μs | ~1.11 | transport_montecarlo_vpacket.BenchmarkMontecarloMontecarloNumbaVpacket.time_trace_bad_vpacket |
| | 1.66±0.4μs | 1.50±0.4μs | ~0.90 | transport_geometry_calculate_distances.BenchmarkTransportGeometryCalculateDistances.time_calculate_distance_line |
| | 3.48±0.6μs | 3.14±0.6μs | ~0.90 | transport_montecarlo_vpacket.BenchmarkMontecarloMontecarloNumbaVpacket.time_trace_vpacket_within_shell |
| | 50.0±20μs | 44.5±20μs | ~0.89 | transport_montecarlo_interaction.BenchmarkTransportMontecarloInteraction.time_line_scatter |
| | 2.44±1μs | 2.11±1μs | ~0.86 | transport_montecarlo_estimators_radfield_estimator_calcs.BenchmarkMontecarloMontecarloNumbaPacket.time_update_line_estimators |
| | 52.5±20μs | 40.3±20μs | ~0.77 | transport_montecarlo_interaction.BenchmarkTransportMontecarloInteraction.time_line_emission |
| | 205±0.4ns | 213±0.3ns | 1.04 | spectrum_formal_integral.BenchmarkTransportMontecarloFormalIntegral.time_intensity_black_body |
| | 521±100ns | 531±200ns | 1.02 | opacities_opacity.BenchmarkMontecarloMontecarloNumbaOpacities.time_compton_opacity_calculation |
| | 561±100ns | 561±200ns | 1.00 | opacities_opacity.BenchmarkMontecarloMontecarloNumbaOpacities.time_pair_creation_opacity_calculation |
| | 2.08±0m | 2.08±0m | 1.00 | spectrum_formal_integral.BenchmarkTransportMontecarloFormalIntegral.time_FormalIntegrator_functions |
| | 1.69±0ms | 1.70±0.01ms | 1.00 | transport_montecarlo_main_loop.BenchmarkTransportMontecarloMontecarloMainLoop.time_montecarlo_main_loop |
| | 37.9±0.08s | 37.4±0.03s | 0.99 | run_tardis.BenchmarkRunTardis.time_run_tardis |
| | 31.3±0.07μs | 31.0±0.02μs | 0.99 | transport_montecarlo_packet_trackers.BenchmarkTransportMontecarloPacketTrackers.time_generate_rpacket_tracker_list |
| | 2.54±0.5ms | 2.53±0.5ms | 0.99 | transport_montecarlo_single_packet_loop.BenchmarkTransportMontecarloSinglePacketLoop.time_single_packet_loop |
| | 1.04±0m | 1.02±0m | 0.98 | run_tardis.BenchmarkRunTardis.time_run_tardis_rpacket_tracking |
| | 23.4±6μs | 23.0±6μs | 0.98 | transport_montecarlo_packet_trackers.BenchmarkTransportMontecarloPacketTrackers.time_generate_rpacket_last_interaction_tracker_list |
| | 1.20±0μs | 1.17±0μs | 0.97 | transport_geometry_calculate_distances.BenchmarkTransportGeometryCalculateDistances.time_calculate_distance_boundary |
| | 64.7±0.2ms | 61.3±0.07ms | 0.95 | transport_montecarlo_packet_trackers.BenchmarkTransportMontecarloPacketTrackers.time_rpacket_trackers_to_dataframe |
| | 7.74±2μs | 7.10±2μs | 0.92 | transport_montecarlo_vpacket.BenchmarkMontecarloMontecarloNumbaVpacket.time_trace_vpacket_volley |
| | 661±100ns | 602±200ns | 0.91 | opacities_opacity.BenchmarkMontecarloMontecarloNumbaOpacities.time_photoabsorption_opacity_calculation |
| | 785±0.2ns | 716±1ns | 0.91 | transport_montecarlo_interaction.BenchmarkTransportMontecarloInteraction.time_thomson_scatter |
If you want to see the graph of the results, you can check it here |
Packet Initialization | ||
===================== | ||
|
||
The gamma ray portion of tardis also uses the idea of packets of photons from :cite:`AbbottLucy85` and :cite:`Lucy99` (see :doc:`initialization`) |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
references not wworking!
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
The citations are working now
The packets are also given a direction made up of two angles, :math:`\theta` and :math:`\phi`, where :math:`\theta` is a polar angle between 0 and :math:`\pi` and :math:`\phi` is an azimuth angle between 0 and :math:`2\pi`. | ||
We sample these angles using the following equations :cite:`CarterCashwell75`: | ||
|
||
:math:`\cos{\theta}` = 1-2 z \ :sub:`1`\ |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Please check if the equations can be placed centrally
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
The equations are now placed centrally.
📝 Description
Type: 📝
documentation
|This is a new pull request to start the gammaray packet documentation. I created an index file for the gamma ray documentation, a file about packet initialization, and finally added the gammaray index to the main index file.
📌 Resources
Examples, notebooks, and links to useful references.
🚦 Testing
How did you test these changes?
☑️ Checklist
build_docs
label