v2023.1.0 #1889

What's Changed

• Merge v0.8.x branch back into main by @namurphy in Merge v0.8.x branch back into main #1616
• Revert "Merge v0.8.x branch back into main" by @rocco8773 in Revert "Merge v0.8.x branch back into main" #1624
• Merge (but do not squash) changes from v0.8.1 by @namurphy in Merge (but do not squash) changes from v0.8.1  #1625
• Correct version in citation instructions by @namurphy in Correct version in citation instructions #1622
• Add a changelog file for dev by @namurphy in Add a changelog file for dev #1623
• Remove usage of np.complex in favor of complex by @namurphy in Remove usage of np.complex in favor of complex #1617
• Update towncrier settings by @namurphy in Update towncrier settings #1626
• Install PlasmaPy from repo when launching notebooks with binder for latest docs by @namurphy in Install PlasmaPy from repo when launching notebooks with binder for latest docs  #1636
• Fix assertions in tests that were always True by @namurphy in Fix assertions in tests that were always True #1634
• Restrict sphinx != 5.1 by @rocco8773 in Restrict sphinx != 5.1 #1645
• Hollweg Dispersion Relation Notebook by @Sjbrownian in Hollweg Dispersion Relation Notebook #1392
• Update the preamble to the coding guide by @namurphy in Update the preamble to the coding guide #1649
• Restrict sphinx_gallery < 0.11 by @rocco8773 in Restrict sphinx_gallery < 0.11 #1654
• Move & revise section on installing and using pre-commit by @namurphy in Move & revise section on installing and using pre-commit #1651
• Add a section to the coding guide on naming best practices by @namurphy in Add a section to the coding guide on naming best practices #1650
• Swept Langmuir | Ion-Saturation Current by @rocco8773 in [SLA] Swept Langmuir | Ion-Saturation Current #1469
• Make docs build off sphinxdev actually build docs by @StanczakDominik in Make docs build off sphinxdev actually build docs #1647
• Update guidelines section of coding guide by @namurphy in Update guidelines section of coding guide #1657
• Add tables of contents to pages in contributor guide by @namurphy in Add tables of contents to pages in contributor guide #1662
• Add sections on comments and error messages in coding guide by @namurphy in Add sections on comments and error messages in coding guide #1660
• Add and apply substitution for array_like by @namurphy in Add and apply substitution for array_like #1666
• Remove integer_charge attributes by @namurphy in Remove integer_charge attributes #1633
• Add sections to coding guide on imports and requirements by @namurphy in Add sections to coding guide on imports and requirements #1659
• Update guidelines for "Parameters", "Raises", and "Warns" sections of docstrings by @namurphy in Update guidelines for "Parameters", "Raises", and "Warns" sections of docstrings #1667
• Add sections on units & particles to coding guide by @namurphy in Add sections on units & particles to coding guide #1655
• Add pygrep-hooks to pre-commit by @namurphy in Add pygrep-hooks to pre-commit #1670
• Test the consistency of requirements defined in different locations by @namurphy in Test the consistency of requirements defined in different locations #1500
• added examples in boris_push docstring by @MKastek in added examples in boris_push docstring #1556
• Add critical_density by @JaydenR2305 in Add critical_density #1664
• Add coding guideline that functions should accept and return numpy.nan values by @namurphy in Add coding guideline that functions should accept and return numpy.nan values #1673
• Add tip to changelog guide on updating broken reST links by @namurphy in Add tip to changelog guide on updating broken reST links #1674
• Move quantum_theta to quantum.py by @JaydenR2305 in Move quantum_theta to quantum.py #1671
• Appease codespell, which now peeks into our notebooks by @StanczakDominik in Appease codespell, which now peeks into our notebooks #1677
• Refactor find_floating_potentional to use return pattern (vf, extras) by @rocco8773 in [SLA] Refactor find_floating_potentional to use return pattern (vf, extras) #1565
• Discuss lite-functions and aliases in the coding guide by @namurphy in Discuss lite-functions and aliases in the coding guide #1658
• Update labeling of pull requests done by GitHub Actions by @namurphy in Update labeling of pull requests done by GitHub Actions #1679
• Attempt to fix intermittent test failure in test_optical_density_histogram by @pheuer in Attempt to fix intermittent test failure in test_optical_density_histogram #1685
• Add NaN check to prevent raising a false relativity error by @TrestanSimon in Add NaN check to prevent raising a false relativity error #1681
• Add a CITATION.cff file by @namurphy in Add a CITATION.cff file #1640
• Resurrect chemical_potential and associated functions by @JaydenR2305 in Resurrect chemical_potential and associated functions #1678
• Add Lundquist number by @TrestanSimon in Add Lundquist number #1642
• Separate the patent clause from the license into its own file by @namurphy in Separate the patent clause from the license into its own file #1686
• Hall parameter tests by @MKastek in Hall parameter tests #1689
• change os.path to pathlib by @MKastek in change os.path to pathlib #1690
• added importlib.metdata in plasmapy/init.py by @MKastek in added importlib.metdata in plasmapy/__init__.py #1692
• Bump minimum NumPy version to 1.20.0 by @namurphy in Bump minimum NumPy version to 1.20.0 #1694
• Add RelativisticBody class to plasmapy.formulary by @namurphy in Add RelativisticBody class to plasmapy.formulary #1540
• Delete redundant changelog entry by @namurphy in Delete redundant changelog entry #1696
• Move ionic_levels to plasmapy.particles.atomic by @namurphy in Move ionic_levels to plasmapy.particles.atomic #1697
• Enable inline code highlighting with :py: role by @namurphy in Enable inline code highlighting with :py: role #1698
• Add CollisionFrequencies by @JaydenR2305 in Add CollisionFrequencies #1676
• Add note in coding guide that we should use pathlib instead of os.path by @namurphy in Add note in coding guide that we should use pathlib instead of os.path #1702
• Remove software requirements from codemeta.json by @namurphy in Remove software requirements from codemeta.json #1701
• Apply |keyword-only| substitution in docstrings and reST files by @namurphy in Apply |keyword-only| substitution in docstrings and reST files #1706
• Add check for unequal array lengths to CollisionFrequencies by @JaydenR2305 in Add check for unequal array lengths to CollisionFrequencies #1705
• Data module by @pheuer in Data module #1486
• Fix documentation build errors by @JaydenR2305 in Fix documentation build errors #1710
• Thomson fitting example notebook by @pheuer in Thomson fitting example notebook #1520
• Enable categorization of CustomParticle objects by @namurphy in Enable categorization of CustomParticle objects #1700
• Update requirements for towncrier and sphinx-changelog by @namurphy in Update requirements for towncrier and sphinx-changelog #1717
• Update docstrings in ParticleList by @namurphy in Update docstrings in ParticleList #1713
• Update versions of black, nbqa, and pyupgrade used by pre-commit by @namurphy in Update versions of black, nbqa, and pyupgrade used by pre-commit #1722
• Bumping astropy dependency to >= 5.0.1 due to numpy.asscalar deprecation by @JaydenR2305 in Bumping astropy dependency to >= 5.0.1 due to numpy.asscalar deprecation #1727
• Move valid_categories to particle_class.py by @namurphy in Move valid_categories to particle_class.py #1720
• Resolve numerical instability in chemical_potential by @JaydenR2305 in Resolve numerical instability in chemical_potential #1726
• Add to docstrings in plasmapy/formulary/magnetostatics.py by @TrestanSimon in Add to docstrings in plasmapy/formulary/magnetostatics.py #1695
• Use pycln to remove unused imports by @namurphy in Use pycln to remove unused imports #1736
• Use issue forms instead of issue templates by @namurphy in Use issue forms instead of issue templates #1733
• Return False when comparing an ionization object to an object of a different type by @namurphy in Return False when comparing an ionization object to an object of a different type #1721
• Add a GitHub Action to post a code review checklist on pull requests by @namurphy in Add a GitHub Action to post a code review checklist on pull requests #1729
• Apply automated Sourcery refactorings by @namurphy in Apply automated Sourcery refactorings #1714
• Revert "Limit CODEOWNERS to pinging plasmapy-reviewers group" by @rocco8773 in Revert "Limit CODEOWNERS to pinging plasmapy-reviewers group" #1739
• Refactor @particle_input and broaden allowed function annotations by @namurphy in Refactor @particle_input and broaden allowed function annotations #1057
• Update deprecated parameter in setup.cfg by @namurphy in Update deprecated parameter in setup.cfg #1740
• Expand usage of particle_input in plasmapy.formulary by @namurphy in Expand usage of particle_input in plasmapy.formulary #1732
• Improve consistency of docstrings, annotations, and signatures in plasmapy.particles by @namurphy in Improve consistency of docstrings, annotations, and signatures in plasmapy.particles #1718
• Show local variables in test failures by @namurphy in Show local variables in test failures #1745
• Move fundamental collision frequencies to MaxwellianCollisionFrequencies by @JaydenR2305 in Move fundamental collision frequencies to MaxwellianCollisionFrequencies #1703
• Move pytest dep from tests to install and update nitpick_ignore_regex to fix new doc build warnings by @StanczakDominik in Move pytest dep from tests to install and update nitpick_ignore_regex to fix new doc build warnings #1749
• Add a troubleshooting section to documentation guide by @namurphy in Add a troubleshooting section to documentation guide #1752
• [pre-commit.ci] pre-commit autoupdate by @pre-commit-ci in [pre-commit.ci] pre-commit autoupdate #1748
• Update release guide after 0.8.1 release by @namurphy in Update release guide after 0.8.1 release #1615
• Change license header to match OSI format by @elliotwutingfeng in Change license header to match OSI format #1764
• Add elliotwutingfeng to credits.rst by @elliotwutingfeng in Add elliotwutingfeng to credits.rst #1766
• Revise changelog entries for 0.9.0 release by @namurphy in Revise changelog entries for 0.9.0 release #1768
• Fix broken hyperlinks and redirects prior to 0.9.0 release by @namurphy in Fix broken hyperlinks and redirects prior to 0.9.0 release #1770
• Delete codemeta.json in favor of CITATION.cff by @namurphy in Delete codemeta.json in favor of CITATION.cff #1772
• Use pretty-format-yaml pre-commit hook on CITATION.cff by @namurphy in Use pretty-format-yaml pre-commit hook on CITATION.cff #1773
• Enable validation of CITATION.cff by @namurphy in Enable validation of CITATION.cff #1771
• Update authors information by @namurphy in Update authors information #1774
• Patch for href code wrapping in cells by @rocco8773 in Patch for href code wrapping in cells #1785
• Mark tests as slow by @namurphy in Mark tests as slow #1783
• Add flake8 extensions by @namurphy in Add flake8 extensions #1777
• Refactoring collisions functionality by @ejohnson-96 in Refactoring collisions functionality #1769
• Add tryceratops as a flake8 extension by @namurphy in Add tryceratops as a flake8 extension #1782
• Add __all__ to particle_integrators.py by @namurphy in Add __all__ to particle_integrators.py #1794
• Automate the release process by @StanczakDominik in Automate the release process #1779
• [MAINT] Merge automatic changes from v0.9.0 release by @StanczakDominik in [MAINT] Merge automatic changes from v0.9.0 release #1798
• Update size labeler GitHub workflow by @namurphy in Update size labeler GitHub workflow #1800
• Add blacken-docs to pre-commit & apply minor reST fixes by @namurphy in Add blacken-docs to pre-commit & apply minor reST fixes #1807
• Change fortnightly tests to weekly even though "fortnightly" sounds waaaay cooler than "weekly" by @namurphy in Change fortnightly tests to weekly even though "fortnightly" sounds waaaay cooler than "weekly" #1808
• Delete size-labeler.yml by @StanczakDominik in Delete size-labeler.yml #1811
• Added relativistic functionality to gyroradius by @MuhammadHMasood in Added relativistic functionality to gyroradius #1813
• Remove pytest-xdist from test requirements by @namurphy in Remove pytest-xdist from test requirements #1822
• Remove deprecated T_i from gyroradius by @tranqver in Remove deprecated T_i from gyroradius #1824
• Fix weekly test configuration error by @namurphy in Fix weekly test configuration error #1827
• Update changelog guide by @namurphy in Update changelog guide #1826
• Add functions to calculate running moments of time series in new time_series sub module by @gregordecristoforo in Add functions to calculate running moments of time series in new time_series sub module #1803
• Return NaN values instead of throw exceptions for particle attributes by @Sobeskes in Return NaN values instead of throw exceptions for particle attributes #1825
• Remove plasmapy.formulary.parameters by @namurphy in Remove plasmapy.formulary.parameters #1833
• Convert setup.cfg to pyproject.toml by @StanczakDominik in Convert setup.cfg to pyproject.toml #1758
• Add flake8 check for line length in docstrings by @namurphy in Add flake8 check for line length in docstrings #1816
• Fixed functional typo in testing_guide.rst by @svincena in Fixed functional typo in testing_guide.rst #1834
• Charged Particle Radiography: Detector Stacks by @pheuer in Charged Particle Radiography: Detector Stacks #1274
• Add a summary section to testing guide by @namurphy in Add a summary section to testing guide #1823
• Update troubleshooting information in doc guide by @namurphy in Update troubleshooting information in doc guide #1817
• Update discussion of parameter type specifications in docstrings by @namurphy in Update discussion of parameter type specifications in docstrings #1757
• Update error messages in Coulomb logarithm calculations by @namurphy in Update error messages in Coulomb logarithm calculations #1586
• Update Read the Docs configuration and add graphviz dependency by @namurphy in Update Read the Docs configuration and add graphviz dependency #1840
• Link to GitHub repository from documentation landing page by @namurphy in Link to GitHub repository from documentation landing page #1839
• Revert fail-on-warning option for Read the Docs build by @namurphy in Revert fail-on-warning option for Read the Docs build #1842
• Fix weekly test against development version of NumPy by @namurphy in Fix weekly test against development version of NumPy #1841
• Apply changes from refurb and ruff to plasmapy.utils by @namurphy in Apply changes from refurb and ruff to plasmapy.utils #1845
• Refactor tests in plasmapy.formulary.relativity by @namurphy in Refactor tests in plasmapy.formulary.relativity #1844
• Apply changes from refurb and ruff to plasmapy.particles by @namurphy in Apply changes from refurb and ruff to plasmapy.particles #1846
• DRAFT: Prad multiple field grids by @pheuer in DRAFT: Prad multiple field grids #1799
• Add ruff section to pyproject.toml by @namurphy in Add ruff section to pyproject.toml #1848
• Pin version of towncrier to address doc build error by @namurphy in Pin version of towncrier to address doc build error #1850
• Apply changes from refurb and ruff to plasmapy.formulary by @namurphy in Apply changes from refurb and ruff to plasmapy.formulary #1847
• Apply ruff --fix to repository by @namurphy in Apply ruff --fix to repository #1849
• Use ruff and refurb on remainder of plasmapy by @namurphy in Use ruff and refurb on remainder of plasmapy #1853
• Pin GitHub Action to specific version for posting code review checklists by @namurphy in Pin GitHub Action to specific version for posting code review checklists #1852
• Fix version of GitHub Action by @namurphy in Fix version of GitHub Action #1855
• Pin GitHub Action to a specific commit by @namurphy in Pin GitHub Action to a specific commit #1857
• Revert updates to GitHub Action by @namurphy in Revert updates to GitHub Action #1859
• Add ruff to pre-commit configuration by @namurphy in Add ruff to pre-commit configuration #1854
• Update create issue links in README.md by @namurphy in Update create issue links in README.md #1858
• Adjust ruff for pre-commit by @StanczakDominik in Adjust ruff for pre-commit #1860
• Drop dev dependencies from pyproject.toml by @StanczakDominik in Drop dev dependencies from pyproject.toml #1843
• Restructure coding guide by @namurphy in Restructure coding guide #1856
• Update README file and copyright year by @namurphy in Update README file and copyright year #1862
• Use pyproject-fmt instead of pretty-format-toml by @namurphy in Use pyproject-fmt instead of pretty-format-toml #1868
• Expand charge number functionality for CustomParticle by @namurphy in Expand charge number functionality for CustomParticle #1866
• [pre-commit.ci] pre-commit autoupdate by @pre-commit-ci in [pre-commit.ci] pre-commit autoupdate #1863
• Update changelog entries and author lists by @namurphy in Update changelog entries and author lists #1876
• Add plep link in docs by @StanczakDominik in Add plep link in docs #1879
• Add separate constructor for CustomParticle by @namurphy in Add separate constructor for CustomParticle #1881
• Update docstring and annotations for spectral_density by @namurphy in Update docstring and annotations for spectral_density #1756
• Drop dependency on cached-property in favor of functools.cached_property by @namurphy in Drop dependency on cached-property in favor of functools.cached_property #1886
• Add strict and allowed_physical_types keyword arguments to _get_physical_type_dict by @namurphy in Add strict and allowed_physical_types keyword arguments to _get_physical_type_dict #1880
• Drop codespell from pyproject.toml reqs by @StanczakDominik in Drop codespell from pyproject.toml reqs #1888
• Add a documentation page on performance tips by @namurphy in Add a documentation page on performance tips #1887

New Contributors

• @MKastek made their first contribution in added examples in boris_push docstring #1556
• @JaydenR2305 made their first contribution in Add critical_density #1664
• @TrestanSimon made their first contribution in Add NaN check to prevent raising a false relativity error #1681
• @elliotwutingfeng made their first contribution in Change license header to match OSI format #1764
• @MuhammadHMasood made their first contribution in Added relativistic functionality to gyroradius #1813
• @tranqver made their first contribution in Remove deprecated T_i from gyroradius #1824
• @gregordecristoforo made their first contribution in Add functions to calculate running moments of time series in new time_series sub module #1803
• @Sobeskes made their first contribution in Return NaN values instead of throw exceptions for particle attributes #1825
• @svincena made their first contribution in Fixed functional typo in testing_guide.rst #1834

Full Changelog: v0.8.1...v2023.1.0