Co-authored-by: Dominik Stańczak <[email protected]>

Co-authored-by: dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com>

Co-authored-by: Nick Murphy <[email protected]>

* Begin changelog guide in developer docs

* More on changelog guide

* Update changelog guide

* Make spelling of "changelog" consistent

The follows the spelling used on Wikipedia, which is also the spelling
used more commonly.

* Add changelog entry

* Expand guide for creating changelog entries

* Add pre-release step about updating changelog entries

* Update changelog guide

* Add changelog_guide to contributor guide doc page

* Update changelog guide

* Fix a typo in doc guide

* Add anchor to release guide

* Fix Sphinx formatting

* Update changelog guide

* Add a pre-release step for updating changelog entries

* Add label to Changelog Guide

* Switch up between changelog docs

I still have a bit more to do to complete this change.

* Refine changelog guide

* Update index, etc. for changelog guide

* Change toctree for changelog

* Add a note about towncrier create --edit

* Add changelog guide to sidebar

* Fix sidebar file location

* Fix the fix that I just "fixed"

Fixing the sidebar reference to the changelog guide.

* Discuss parametrization with argument unpacking in testing guide

* Continue updates to doc guide

* Update testing guide

* Minor changes

* Add a changelog entry

* Change subsection title

* Consistentify reST indentations

Co-authored-by: seanjunheng2 <[email protected]>
Co-authored-by: pre-commit-ci[bot] <66853113+pre-commit-ci[bot]@users.noreply.github.com>

Co-authored-by: tlee0818 <[email protected]>
Co-authored-by: Andrew Sheng <[email protected]>
Co-authored-by: Terrance Takho Lee <[email protected]>
Co-authored-by: mahimapannala <[email protected]>
Co-authored-by: itsraashi <[email protected]>
Co-authored-by: pre-commit-ci[bot] <66853113+pre-commit-ci[bot]@users.noreply.github.com>
Co-authored-by: Dominik Stańczak <[email protected]>

Co-authored-by: Dominik Stańczak <[email protected]>

Co-authored-by: Nick Murphy <[email protected]>

Co-authored-by: Dominik Stańczak <[email protected]>

* Try to fix linter errors in validators.py

* Try to fix linter errors in plasmablob.py

* Try to fix linter errors in grids.py

* Try to fix linter errors in fit_functions.py

* Try to fix linter errors in checks.py

* Update docstring one-liners

* Add docstring for func_err

* Update docstrings in fit_functions.py

* Move docstring from __init__ to class

* Return fit_functions.py to previous state

* Ignore flake8 rst error in fit_functions.py

Co-authored-by: Nick Murphy <[email protected]>

…et plasma parameters (#1229)

* [notebook-939]: Create interactive notebook for calc parameters

* Calculate Properties - interactive notebook base architecture

This commit creates provision to add/ remove calculation paramters on demand

* Add changelog entry

* [WIP] added more functions

* Added and classified input parameters and unit options

* Add convert to Hz widget

* Scratch update

* Separate code away from notebook

* Add clear everything button

* Clear output and rename notebook

* better evaluation display

* Script to launch app using voila

* Update properties with more formulary functions

* Clear output container nit

* Address Review Comments

Fix changelog entry, Clear output entries, Fix properties typo
Privatization of internal classes

* Make classes and functions private and use enums for colors

* Install calculator as a standalone cmdline tool

Cross platform tested with windows , when there are no sufficient elevation rights
one can install it with --user flag to ignore installation

* Move Calculator to utils instead of root

* Add favicon and dark mode

* Remove use of os.system - error thrown by dlint

* [pre-commit.ci] auto fixes from pre-commit.com hooks

for more information, see https://pre-commit.ci

* Use run to prevent orphan process

* Graceful exit with message

* Move Calculator logic to utils

* Add notebook to installation and sphinx docstring

* [pre-commit.ci] auto fixes from pre-commit.com hooks

for more information, see https://pre-commit.ci

* Add missing dependency

* Add ipywidgets to installation requirements

* Fix build failure because of eg

* Fix lint failures

* Address Review Comments

* Add back requirements to fix merge conflict

* Fix Documentation Build failure

* [pre-commit.ci] auto fixes from pre-commit.com hooks

for more information, see https://pre-commit.ci

* Use abstractmethod wrapper and add period to all descriptions

For consistency within the description section

* [pre-commit.ci] auto fixes from pre-commit.com hooks

for more information, see https://pre-commit.ci

* Fix documentation build because of heading line

* adjust coverage settings

* Address Review Commits

Cleanup private member doc

Co-authored-by: Rajagopalan Gangadharan <[email protected]>
Co-authored-by: pre-commit-ci[bot] <66853113+pre-commit-ci[bot]@users.noreply.github.com>
Co-authored-by: Dominik Stańczak <[email protected]>

Co-authored-by: dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com>

* BibTeXify dielectric references

* BibTeXify references from coupling_parameter

* Use hyperlink for Knudsen number

* Minor formatting edit

* Inline link for mobility

* Add Chen reference and drop Callen draft book reference

We don't have a permalink for the Callen draft book, unfortunately.
It'd be helpful to replace it with another reference later on.

* Minor bibliography edits

* Update references in collisions.py

* Finish putting references in bibtex file

* Bibtexify dielectric.py more

* Update/remove references in drifts.py

* Update reference in parameters.py

* Update references in braginskii.py

* Bibtexify references in quantum.py

* Remove trailing commas

* Put in a missing comma

* Add references to bibtex file

* Update references

* [pre-commit.ci] auto fixes from pre-commit.com hooks

for more information, see https://pre-commit.ci

* Add changelog entry

* Use the same sorting for keys in @Article entries

* Fix citation key

* Change editions from, e.g., "1" to "1st"

* Quotes around titles to preserve capitalization

* Preserve capitalization

Co-authored-by: pre-commit-ci[bot] <66853113+pre-commit-ci[bot]@users.noreply.github.com>

* Expand xrefs in docs for particles

* Use substitutions in functional particles docs

* Use substitutions in nuclear.rst

* Use substitutions for docstrings of Particle instances

* Use substitution for ParticleTracker

* Formatting changes for stability.rst

* Fix ReST link in Particle

* Change file location to literal text

* Add change log entry

* Fix typo

* And inf and nan to Sphinx replacements

* Move substitutions for particle functions to common_links

* Revert "And inf and nan to Sphinx replacements"

This reverts commit 7077714.

* Update reST formatting

* Update changelog entry

* Add reST substitutions for nan and inf

* Fix a link

* Change substitutions to use correct modeul

* Minor formatting change for line length

* Fix lingering incorrect namespace

* Discuss module docstrings and __all__

* Minor rewording

* Add changelog entry

* Discuss connection between __all__ and star imports

Co-authored-by: Dominik Stańczak <[email protected]>

* Continue working on particle factory & tests

* Move particle factory function to a new file

This is to avoid having to avoid circularity. particle_class.py
defines Particle, and particle_collections.py imports Particle to
define ParticleList. Prior to this commit, we had the factory function
in particle_class.py, where it imported ParticleList.

* Allow first two arguments of CustomParticle to be switched

* Finish CustomParticle having reversed argument order

* Update particle factory

* Remove edits to CustomParticle

These edits were moved to a different pull request.

* Add changelog entry

* Simplify discussion of parameters

* Mark a test as xfail

This will be ex-xfailed after #1364 is merged.

* Temporarily add particle factory stuff to __all__

* Make particle factory function private

* Refine docs & tests of particle factory

* Extract some methods from start of Particle.__init__

* Extract special particle creation method

* Create empty method to initialize atoms

* Expand method to create atoms

* Minor updates to Particle initialization

* Minor updates to Particle initialization

* Add changelog entry

* Minor formatting fix

Co-authored-by: Dominik Stańczak <[email protected]>

* [pre-commit.ci] auto fixes from pre-commit.com hooks

for more information, see https://pre-commit.ci

Co-authored-by: Dominik Stańczak <[email protected]>
Co-authored-by: pre-commit-ci[bot] <66853113+pre-commit-ci[bot]@users.noreply.github.com>

…alType` objects as keys (#1360)

* Begin function to sort by physical type

* First draft of get_physical_type_dict

* First draft of get_physical_type_dict tests

* Add a changelog entry

* Make function private

* Make function private - part 2

* Add file docstring for tests

* Add test case and expand docstring

* Require Astropy v4.3.1 or newer

...for PhysicalType functionality.

* Update astropy version in tox.ini

* Mention Astropy version increase

* Describe more make envs for doc build

* Adjust line length

* Add changelog entry

* Update copyright year in license to 2022

* Minor docstring edits to braginskii.py

* Minor docstring edits to mathematics.py

* Minor docstring edits to parameters.py

* Minor docstring edits to quantum.py

* Minor docstring edits to radiation.py

* Minor docstring edits to braginskii.py

* Minor docstring edits to mathematics.py

* Minor docstring edits to quantum.py

…nts to 2.11.0 (#1361)

* [pre-commit.ci] pre-commit autoupdate

updates:
- [github.com/macisamuele/language-formatters-pre-commit-hooks: v2.3.0 → v2.4.0](macisamuele/language-formatters-pre-commit-hooks@v2.3.0...v2.4.0)

* [pre-commit.ci] auto fixes from pre-commit.com hooks

for more information, see https://pre-commit.ci

Co-authored-by: pre-commit-ci[bot] <66853113+pre-commit-ci[bot]@users.noreply.github.com>

I previously created the v0.8.0 tag, but the release step errored out
because there was a problem with PyPI authentication. Unfortunately,
once a tag is created on GitHub, it can't be deleted (‽‽‽). Because
releases are based on tags, I don't appear to be able to create a
v0.8.0 release.  The least headacheful workaround is to skip v0.8.0
and release v0.8.1 instead.