PlasmaPy v2023.1.0 (2023-01-13)

Backwards Incompatible Changes

Moved the charged particle radiography analysis codes into a new module charged_particle_radiography containing synthetic radiography tools in synthetic_radiography and detector stack calculation tools in detector_stacks. (#1274)
Changed the gyroradius function so that it takes relativistic effects into account by default. (#1813)

Changed the gyroradius function so it no longer accepts deprecated T_i. (#1824)
Removed plasmapy.formulary.parameters, which was deprecated in the 0.7.0 release. The functionality in that module had previously been migrated to modules that are broken down by physical type, such as: plasmapy.formulary.densities, plasmapy.formulary.dimensionless, plasmapy.formulary.frequencies, plasmapy.formulary.lengths, plasmapy.formulary.misc, and plasmapy.formulary.speeds. (#1833)
Deprecated providing a real number to the charge parameter of CustomParticle to represent the charge number. Use Z instead. (#1866)

Added the Stack and Layer objects to the charged_particle_radiography module, which represent a stack of detector media layers. The deposition_curves and energy_bands methods of Stack calculate the particle energies deposited in each detector layer. (#1274)
Tracker now supports multiple field grids, provided as an iterable. (#1799)
Added the plasmapy.analysis.time_series.running_moments module including two functions for calculating running moments of time series. (#1803)
Added lorentzfactor as an optional keyword-only argument to gyroradius. Also added relativistic as an optional keyword-only argument which can be set to False for the non-relativistic approximation. (#1813)
Modified Particle attributes to return nan in the appropriate units when undefined rather than raising exceptions. (#1825)
Added the charge_number attribute to CustomParticle. (#1866)
Added Z as a keyword-only parameter representing the charge number to CustomParticle. (#1866)

Updated docstrings and annotations in plasmapy.diagnostics.thomson. (#1756)
Updated the discussion on type descriptions and parameter descriptions for docstrings in the Documentation Guide. (#1757)
Updated troubleshooting sections of the Documentation Guide. (#1817)
Added a summary section to the Testing Guide. (#1823)
Updated the Changelog Guide. (#1826)
Reorganized the Coding Guide. (#1856)
Added a documentation page on performance tips. (#1887)

Updated warning messages in Coulomb_logarithm. (#1586)
Transferred most of the contents of setup.py and setup.cfg to pyproject.toml (see PEP 518 and PEP 621). Simplified extras requirements (pip install plasmapy[all] and [extras] are gone). (#1758)
Added blacken-docs to the pre-commit configuration. (#1807)
Removed pytest-xdist from the testing requirements (see also #750). (#1822)
Refactored tests of Lorentz_factor and relativistic_energy. (#1844)
Applied refactorings from ruff and refurb to plasmapy.utils. (#1845)
Applied changes from refurb to plasmapy.particles. (#1846)
Applied changes from refurb to plasmapy.formulary. (#1847)
Apply changes from ruff and refurb to plasmapy.analysis, plasmapy.diagnostics, plasmapy.dispersion, and plasmapy.plasma. (#1853)
Added ruff to the pre-commit configuration. (#1854)
Added the strict and allowed_physical_types parameters to plasmapy.utils._units_helpers._get_physical_type_dict. (#1880)
Added a private constructor method to CustomParticle with an API that is better suited for use in ParticleList and the particle factory function used by particle_input(). (#1881)
Dropped the dependency on cached-property in favor of functools.cached_property. (#1886)