Example notebook for proton radiography custom source capability #1054
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
|
Check out this pull request on See visual diffs & provide feedback on Jupyter Notebooks. Powered by ReviewNB |
Codecov ReportAll modified and coverable lines are covered by tests ✅
Additional details and impacted files@@ Coverage Diff @@
## master #1054 +/- ##
==========================================
+ Coverage 96.89% 96.90% +0.01%
==========================================
Files 70 70
Lines 6920 6925 +5
==========================================
+ Hits 6705 6711 +6
+ Misses 215 214 -1 ☔ View full report in Codecov by Sentry. |
|
@rocco8773 Can you take a look at this one? |
|
@pheuer Yes, I'll take a look over it. Give me today/tomorrow to get to it. Thanks. |
rocco8773
added
plasmapy.diagnostics
rocco8773
requested changes
Mar 7, 2021
There was a problem hiding this comment.
@pheuer Here's a partial review of the notebook. The notebook looks to be in good condition, but there are a few things to address.
- As you can see in my first cell comment, Sphinx's normal linking mechanisms don't work in notebooks. Instead we have to manually create links using markdown's syntax. Can you go through your notebook and add these links to documentation whenever you're referencing
plasmapy's functionality or any external pkgs likenumpy. - This notebook is long enough that it might warrant making a table of contents at the top of the notebook. If you feel you'd like to go this way, take a look at the Fit Function notebook and/or Floating Potential notebook.
- Can you please optimize the plot sizes and font sizes? More so the font sizes. The font sizes are a little too small for readability in a web browser. For tips you can again refer to the Fit Function and Floating Potential notebooks.
- [optional] When plotting the particle distributions, it might be easier for users to interpret the plots if they are normalized to the total number of particles in the distribution
N / No / dSigma. If you go this route,Noshould be included somewhere in the plot.
docs/notebooks/proton_radiography_particle_tracing_custom_source.ipynb
Outdated
Show resolved
Hide resolved
docs/notebooks/proton_radiography_particle_tracing_custom_source.ipynb
Outdated
Show resolved
Hide resolved
docs/notebooks/proton_radiography_particle_tracing_custom_source.ipynb
Outdated
Show resolved
Hide resolved
docs/notebooks/proton_radiography_particle_tracing_custom_source.ipynb
Outdated
Show resolved
Hide resolved
docs/notebooks/proton_radiography_particle_tracing_custom_source.ipynb
Outdated
Show resolved
Hide resolved
docs/notebooks/proton_radiography_particle_tracing_custom_source.ipynb
Outdated
Show resolved
Hide resolved
docs/notebooks/proton_radiography_particle_tracing_custom_source.ipynb
Outdated
Show resolved
Hide resolved
|
@rocco8773 Great, thanks for the review. I think I've addressed all your comments |
rocco8773
reviewed
Mar 12, 2021
rocco8773
reviewed
Mar 12, 2021
rocco8773
reviewed
Mar 12, 2021
rocco8773
reviewed
Mar 12, 2021
rocco8773
reviewed
Mar 12, 2021
rocco8773
reviewed
Mar 12, 2021
Co-authored-by: Erik Everson <[email protected]>
rocco8773
reviewed
Mar 12, 2021
…/pheuer/PlasmaPy into prad_custom_source_example_ipynb
Co-authored-by: Erik Everson <[email protected]>
rocco8773
reviewed
Mar 12, 2021
Co-authored-by: Erik Everson <[email protected]>
rocco8773
reviewed
Mar 12, 2021
Co-authored-by: Erik Everson <[email protected]>
rocco8773
requested changes
Mar 12, 2021
|
No problem - change log entry created! |
rocco8773
approved these changes
Mar 12, 2021
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
This PR adds an example notebook demonstrating how users can use
SyntheticProtonRadiographto create synthetic proton radiographs using custom lists of initialized particles, and how this capability allows the creation of synthetic radiographs with arbitrary source fluence profiles.(Previously
load_particleswasn't used in any of the example notebooks)This PR also now includes minor changes to the other PRad notebooks too (mostly adding links).
TODO:
rot_a_to_b()in mathematics. Requires making atest_mathematics.pyfile.