Easier Output Saving for Proton Radiography

changelog/1134.breaking.2.rst

@@ -0,0 +1,2 @@
+Added the `save_results()` function to `Tracker` to save results to a `numpy.npz` file.
+`synthetic_radiograph` is now a separate function in the `charged_particle_radiograph` module that takes either a `Tracker` object or a result dictionary as an argument.

changelog/1134.breaking.3.rst

@@ -0,0 +1,2 @@
+`~plasmapy.diagnostics.charged_particle_radiograph.Tracker()` no longer supports making changes to a `Tracker` object and re-running.
+Subsequent simulations should be performed by instantiating a new `Tracker` object.

changelog/1134.breaking.rst

@@ -0,0 +1,2 @@
+Renamed `~plasmapy.diagnostics.proton_radiography` to `~plasmapy.diagnostics.charged_particle_radiography`,
+and renamed the `SyntheticProtonRadiograph` class within that module to `Tracker`.

changelog/1134.bug.rst

@@ -0,0 +1,2 @@
+`~plasmapy.diagnostics.charged_particle_radiograph.synthetic_radiograph` run with the `optical_density` keyword will now return `np.nan` where the
+source profile `I0` is zero. Previously, an incorrect value was returned.

changelog/1134.trivial.rst

@@ -0,0 +1,2 @@
+`~plasmapy.diagnostics.charged_particle_radiograph.synthetic_radiograph` now determines the default detector size to be the smallest
+detector plane centered on the origin that includes all particles.

docs/ad/diagnostics/charged_particle_radiography.rst

@@ -0,0 +1,16 @@
+.. _charged_particle_radiography:
+
+*************************************
+Charged particle radiography analysis
+*************************************
+
+.. currentmodule:: plasmapy.diagnostics.charged_particle_radiography
+
+.. automodapi:: plasmapy.diagnostics.charged_particle_radiography
+
+.. nbgallery::
+    :caption: Examples
+
+    /notebooks/diagnostics/charged_particle_radiography_particle_tracing
+    /notebooks/diagnostics/charged_particle_radiography_particle_tracing_custom_source
+    /notebooks/diagnostics/charged_particle_radiography_particle_tracing_wire_mesh

docs/ad/diagnostics/index.rst

@@ -10,7 +10,7 @@
    :maxdepth: 1
    :caption: Sub-Packages & Modules
 
-   proton_radiography
+   charged_particle_radiography
    Swept Langmuir (will be deprecated) <langmuir>
    thomson
 

docs/index.rst

@@ -9,7 +9,7 @@ PlasmaPy Documentation
 .. nbgallery::
    :hidden:
 
-   notebooks/diagnostics/proton_radiography_particle_tracing
+   notebooks/diagnostics/charged_particle_radiography_particle_tracing
    notebooks/dispersion/two_fluid_dispersion
    notebooks/diagnostics/thomson