Pull changes from the v2024.2.0 back into main (PlasmaPy#2500)

* Update citation and changelog index entry * Add changelog entries for v2024.2.0 --------- Co-authored-by: PlasmaPy Release Bot <[email protected]>
MKastek · Feb 6, 2024 · 7a2b715 · 7a2b715
1 parent 90a13c2
commit 7a2b715
Show file tree

Hide file tree

Showing 32 changed files with 197 additions and 61 deletions.
diff --git a/CHANGELOG.rst b/CHANGELOG.rst
@@ -1,3 +1,99 @@
+PlasmaPy v2024.2.0 (2024-02-06)
+===============================
+
+Backwards Incompatible Changes
+------------------------------
+
+- Created new `~plasmapy.simulation.particle_tracker.ParticleTracker`
+  object for general particle pushing simulations involving
+  electromagnetic fields. The tracker replaces the old
+  ``~plasmapy.simulation.particletracker.ParticleTracker``. (:pr:`2245`)
+- Imports of classes and functions from `plasmapy.utils` must now be made
+  directly from the subpackages and modules, rather than from `plasmapy.utils`
+  itself. (:pr:`2403`)
+- Moved ``mass_density`` and its alias ``rho_`` from `plasmapy.formulary.misc`
+  to `plasmapy.formulary.densities`. (:pr:`2410`)
+
+
+Features
+--------
+
+- Added a ``notch`` argument to
+  `~plasmapy.diagnostics.thomson.spectral_density`,
+  which allows users to output spectrum over one or multiple wavelength
+  ranges to correspond to a notch filter commonly applied to experimentally
+  measured Thomson scattering spectra. Changed the
+  `~plasmapy.diagnostics.thomson.spectral_density_model` function to allow
+  ``notch`` to be applied during fitting. (:pr:`2058`)
+- Changed unit annotations to |Quantity| type hint annotations. (:pr:`2421`)
+- Enabled |particle_input| to decorate functions which have variadic
+  positional arguments followed by keyword arguments. See :issue:`2150`.
+  (:pr:`2428`)
+- Added a ``random_seed`` keyword in
+  the
+  `~plasmapy.diagnostics.charged_particle_radiography.synthetic_radiography.Tracker.create_particles`
+  method of the
+  `~plasmapy.diagnostics.charged_particle_radiography.synthetic_radiography.Tracker`
+  class
+  to make the function deterministic to resolve intermittent test failures.
+  (:pr:`2487`)
+
+
+Bug Fixes
+---------
+
+- Enabled |particle_input| to be compatible with postponed evaluation of
+  annotations (see :pep:`563`). (:pr:`2479`)
+
+
+Improved Documentation
+----------------------
+
+- Switched from ``sphinx_toolbox.collapse`` to ``sphinx_collapse`` for
+  including collapsible content in our documentation. (:pr:`2387`)
+- Added a discussion of |type hint annotations| in the |testing guide|
+  within the |contributor guide|. (:pr:`2440`)
+
+
+Trivial/Internal Changes
+------------------------
+
+- Added Python 3.12 to the suite of continuous integration tests. (:pr:`2368`)
+- Added a GitHub Action that will create an issue containing a release
+  checklist, which will largely supersede the release process outlined
+  in the |contributor guide|. (:pr:`2376`)
+- Separated the GitHub Action for checking hyperlinks in the
+  documentation into its own GitHub Action. (:pr:`2392`)
+- Replaced |black| with |ruff| in the |pre-commit| configuration. (:pr:`2394`)
+- Modified the ``__exit__`` method of ``HDF5Reader`` for context management.
+  (:pr:`2402`)
+- Added an initial configuration for |mypy| that temporarily ignores existing
+  errors. (:pr:`2424`)
+- Added a |tox| environment for running |mypy|. (:pr:`2431`)
+- Added |mypy| to the suite of continuous integration checks. (:pr:`2432`)
+- Used ``autotyping`` to implement |type hint annotations| for special
+  methods like ``__init__`` and ``__str__``, and changed ``-> typing.NoReturn``
+  annotations to ``-> None``. (:pr:`2437`)
+- Used ``autotyping`` to add :py:`-> None` return annotations to functions
+  and methods with no :py:`return` statement. (:pr:`2439`)
+- Added a stub file containing |type hint annotations| for
+  ``@wrapt.decorator``. (:pr:`2442`)
+- Improved |type hint annotations| for `plasmapy.particles.decorators`,
+  which includes |particle_input|, and the corresponding tests. (:pr:`2443`)
+- Dropped the |pre-commit| hook for ``isort`` and enabled all ``isort``
+  rules in |ruff|. (:pr:`2453`)
+- Added a :file:`py.typed` marker to indicate that PlasmaPy contains
+  type hint annotations as per :pep:`561`. (:pr:`2473`)
+- Changed ``_nearest_neighbor_interpolator`` method in `~plasmapy.plasma.grids`
+  to interpolate quantities array instead of producing an intermediate index.
+  (:pr:`2475`)
+- Enabled the ``sphinx`` linkchecker in quiet mode to make it easier to find
+  problem links from the console output. (:pr:`2476`)
+- Bumped the minimum versions of dependencies to drop support for
+  minor releases older than two years old. In particular, the minimum
+  version of NumPy was bumped to ``1.23.0``. (:pr:`2488`)
+
+
 PlasmaPy v2023.10.0 (2023-10-20)
 ================================
 

diff --git a/CITATION.cff b/CITATION.cff
@@ -1,10 +1,10 @@
 title: PlasmaPy
 type: software
-version: 2023.10.0
+version: 2024.2.0
 identifiers:
 - type: doi
-  value: 10.5281/zenodo.10011217
-date-released: '2023-10-20'
+  value: 10.5281/zenodo.10613904
+date-released: '2024-02-06'
 message: >-
   Please cite the specific version of PlasmaPy used
   during a research project.

diff --git a/changelog/2058.feature.rst b/changelog/2058.feature.rst
diff --git a/changelog/2245.breaking.rst b/changelog/2245.breaking.rst
diff --git a/changelog/2368.trivial.rst b/changelog/2368.trivial.rst
diff --git a/changelog/2376.trivial.rst b/changelog/2376.trivial.rst
diff --git a/changelog/2387.doc.rst b/changelog/2387.doc.rst
diff --git a/changelog/2392.trivial.rst b/changelog/2392.trivial.rst
diff --git a/changelog/2394.trivial.rst b/changelog/2394.trivial.rst
diff --git a/changelog/2402.trivial.rst b/changelog/2402.trivial.rst
diff --git a/changelog/2403.breaking.rst b/changelog/2403.breaking.rst
diff --git a/changelog/2410.breaking.rst b/changelog/2410.breaking.rst
diff --git a/changelog/2421.feature.rst b/changelog/2421.feature.rst
diff --git a/changelog/2424.trivial.rst b/changelog/2424.trivial.rst
diff --git a/changelog/2428.feature.rst b/changelog/2428.feature.rst
diff --git a/changelog/2431.trivial.rst b/changelog/2431.trivial.rst
diff --git a/changelog/2432.trivial.rst b/changelog/2432.trivial.rst
diff --git a/changelog/2437.trivial.rst b/changelog/2437.trivial.rst
diff --git a/changelog/2439.trivial.rst b/changelog/2439.trivial.rst
diff --git a/changelog/2440.doc.rst b/changelog/2440.doc.rst
diff --git a/changelog/2442.trivial.rst b/changelog/2442.trivial.rst
diff --git a/changelog/2443.trivial.rst b/changelog/2443.trivial.rst
diff --git a/changelog/2453.trivial.rst b/changelog/2453.trivial.rst
diff --git a/changelog/2473.trivial.rst b/changelog/2473.trivial.rst
diff --git a/changelog/2475.trivial.rst b/changelog/2475.trivial.rst
diff --git a/changelog/2476.trivial.rst b/changelog/2476.trivial.rst
diff --git a/changelog/2479.bugfix.rst b/changelog/2479.bugfix.rst
diff --git a/changelog/2487.feature.rst b/changelog/2487.feature.rst
diff --git a/changelog/2488.trivial.rst b/changelog/2488.trivial.rst
diff --git a/docs/about/citation.rst b/docs/about/citation.rst
@@ -3,9 +3,9 @@
 Acknowledging and Citing
 ========================
 
-.. |version_to_cite| replace:: 2023.10.0
-.. |doi_hyperlink| replace:: https://doi.org/10.5281/zenodo.10011217
-.. |citation_year| replace:: 2023
+.. |version_to_cite| replace:: 2024.2.0
+.. |doi_hyperlink| replace:: https://doi.org/10.5281/zenodo.10613904
+.. |citation_year| replace:: 2024
 
 If you use PlasmaPy for a project that results in a publication, we ask
 that you cite the |Zenodo| record for the specific version of PlasmaPy

diff --git a/docs/changelog/2024.2.0.rst b/docs/changelog/2024.2.0.rst
@@ -0,0 +1,94 @@
+PlasmaPy v2024.2.0 (2024-02-06)
+===============================
+
+Backwards Incompatible Changes
+------------------------------
+
+- Created new `~plasmapy.simulation.particle_tracker.ParticleTracker`
+  object for general particle pushing simulations involving
+  electromagnetic fields. The tracker replaces the old
+  ``~plasmapy.simulation.particletracker.ParticleTracker``. (:pr:`2245`)
+- Imports of classes and functions from `plasmapy.utils` must now be made
+  directly from the subpackages and modules, rather than from `plasmapy.utils`
+  itself. (:pr:`2403`)
+- Moved ``mass_density`` and its alias ``rho_`` from `plasmapy.formulary.misc`
+  to `plasmapy.formulary.densities`. (:pr:`2410`)
+
+
+Features
+--------
+
+- Added a ``notch`` argument to
+  `~plasmapy.diagnostics.thomson.spectral_density`,
+  which allows users to output spectrum over one or multiple wavelength
+  ranges to correspond to a notch filter commonly applied to experimentally
+  measured Thomson scattering spectra. Changed the
+  `~plasmapy.diagnostics.thomson.spectral_density_model` function to allow
+  ``notch`` to be applied during fitting. (:pr:`2058`)
+- Changed unit annotations to |Quantity| type hint annotations. (:pr:`2421`)
+- Enabled |particle_input| to decorate functions which have variadic
+  positional arguments followed by keyword arguments. See :issue:`2150`.
+  (:pr:`2428`)
+- Added a ``random_seed`` keyword in
+  the
+  `~plasmapy.diagnostics.charged_particle_radiography.synthetic_radiography.Tracker.create_particles`
+  method of the
+  `~plasmapy.diagnostics.charged_particle_radiography.synthetic_radiography.Tracker`
+  class
+  to make the function deterministic to resolve intermittent test failures.
+  (:pr:`2487`)
+
+
+Bug Fixes
+---------
+
+- Enabled |particle_input| to be compatible with postponed evaluation of
+  annotations (see :pep:`563`). (:pr:`2479`)
+
+
+Improved Documentation
+----------------------
+
+- Switched from ``sphinx_toolbox.collapse`` to ``sphinx_collapse`` for
+  including collapsible content in our documentation. (:pr:`2387`)
+- Added a discussion of |type hint annotations| in the |testing guide|
+  within the |contributor guide|. (:pr:`2440`)
+
+
+Trivial/Internal Changes
+------------------------
+
+- Added Python 3.12 to the suite of continuous integration tests. (:pr:`2368`)
+- Added a GitHub Action that will create an issue containing a release
+  checklist, which will largely supersede the release process outlined
+  in the |contributor guide|. (:pr:`2376`)
+- Separated the GitHub Action for checking hyperlinks in the
+  documentation into its own GitHub Action. (:pr:`2392`)
+- Replaced |black| with |ruff| in the |pre-commit| configuration. (:pr:`2394`)
+- Modified the ``__exit__`` method of ``HDF5Reader`` for context management.
+  (:pr:`2402`)
+- Added an initial configuration for |mypy| that temporarily ignores existing
+  errors. (:pr:`2424`)
+- Added a |tox| environment for running |mypy|. (:pr:`2431`)
+- Added |mypy| to the suite of continuous integration checks. (:pr:`2432`)
+- Used ``autotyping`` to implement |type hint annotations| for special
+  methods like ``__init__`` and ``__str__``, and changed ``-> typing.NoReturn``
+  annotations to ``-> None``. (:pr:`2437`)
+- Used ``autotyping`` to add :py:`-> None` return annotations to functions
+  and methods with no :py:`return` statement. (:pr:`2439`)
+- Added a stub file containing |type hint annotations| for
+  ``@wrapt.decorator``. (:pr:`2442`)
+- Improved |type hint annotations| for `plasmapy.particles.decorators`,
+  which includes |particle_input|, and the corresponding tests. (:pr:`2443`)
+- Dropped the |pre-commit| hook for ``isort`` and enabled all ``isort``
+  rules in |ruff|. (:pr:`2453`)
+- Added a :file:`py.typed` marker to indicate that PlasmaPy contains
+  type hint annotations as per :pep:`561`. (:pr:`2473`)
+- Changed ``_nearest_neighbor_interpolator`` method in `~plasmapy.plasma.grids`
+  to interpolate quantities array instead of producing an intermediate index.
+  (:pr:`2475`)
+- Enabled the ``sphinx`` linkchecker in quiet mode to make it easier to find
+  problem links from the console output. (:pr:`2476`)
+- Bumped the minimum versions of dependencies to drop support for
+  minor releases older than two years old. In particular, the minimum
+  version of NumPy was bumped to ``1.23.0``. (:pr:`2488`)
diff --git a/docs/changelog/index.rst b/docs/changelog/index.rst
@@ -12,6 +12,7 @@ including bug fixes and changes to the application programming interface
    :maxdepth: 1
 
    dev
+   2024.2.0
    2023.10.0
    2023.5.1
    2023.5.0
-Original file line number
+Diff line change
@@ Expand Up @@
        :maxdepth: 1
        dev
+.2.0
 .10.0
 .5.1
 .5.0
@@ Expand Down @@