setup.cfg

[metadata]
name = plasmapy
provides = plasmapy
author = PlasmaPy Community
description = Python package for plasma physics
long_description = file: README.md
long_description_content_type = text/markdown
license = BSD-3-Clause
license_files = LICENSE.md
url = https://www.plasmapy.org
project_urls =
    Documentation=https://docs.plasmapy.org/
    Changelog=https://docs.plasmapy.org/en/stable/whatsnew/index.html
    Source=https://github.com/plasmapy/plasmapy
    Issues=https://github.com/plasmapy/plasmapy/issues/
    Twitter=https://twitter.com/PlasmaPy
    Chat=https://plasmapy.org/chat
edit_on_github = True
github_project = PlasmaPy/PlasmaPy
keywords = plasma physics, plasma, science, atomic
classifiers =
    Development Status :: 4 - Beta
    Intended Audience :: Science/Research
    License :: OSI Approved :: BSD License
    Operating System :: OS Independent
    Programming Language :: Python :: 3
    Programming Language :: Python :: 3.8
    Programming Language :: Python :: 3.8
    Programming Language :: Python :: 3.9
    Programming Language :: Python :: 3.10
    Programming Language :: Python :: Implementation :: CPython
    Topic :: Scientific/Engineering :: Physics
    Topic :: Scientific/Engineering :: Astronomy

[options]
python_requires = >=3.8
packages = find:
include_package_data = True
setup_requires =
    # PEP-518 encourages the use of pyproject.toml for defining
    # build dependencies...they should be defined under build-system.requires
install_requires =
    # ought to mirror requirements/install.txt
    astropy >= 5.0.1
    cached-property >= 1.5.2
    h5py >= 3.0.0
    ipywidgets >= 7.6.5
    lmfit >= 1.0.0
    matplotlib >= 3.3.0
    mpmath >= 1.2.1
    numba
    numpy >= 1.20.0
    packaging
    pandas >= 1.0.0
    pytest >= 5.4.0
    scipy >= 1.5.0
    tqdm >= 4.41.0
    voila >= 0.2.15
    wrapt
    xarray >= 0.15.0
    requests >= 2.27.1

[options.extras_require]
# a weird "bug" since python 2 allows extras to depend on extras
# for backwards compatibility, setuptools will keep this active
# see https://github.com/pypa/setuptools/issues/1260#issuecomment-438187625
extras =
    # ought to mirror requirements/extras.txt
    # for developers
    codespell
    pre-commit
    tox
tests =
    # ought to mirror requirements/tests.txt
    %(extras)s
    cffconvert
    dlint
    flake8
    flake8-absolute-import
    flake8-builtins
    flake8-comments
    flake8-implicit-str-concat
    flake8-mutable
    flake8-rst-docstrings
    flake8-simplify
    flake8-use-fstring
    flake8-use-pathlib
    hypothesis
    pydocstyle
    pytest-regressions
    pytest-xdist
    tomli
    tryceratops
docs =
    # ought to mirror requirements/docs.txt
    %(extras)s
    docutils
    ipykernel
    # TODO: release of 3.1 broke CI tests, this should be revisited later (2022-03-24)
    jinja2 != 3.1
    nbsphinx
    numpydoc
    pillow
    pygments >= 2.11.0
    sphinx >= 4.4, != 5.1
    sphinx-changelog >= 1.2.0
    sphinx-copybutton
    sphinx-gallery < 0.11.0
    sphinx-hoverxref >= 1.1.1
    sphinx-issues >= 3.0.1
    sphinx-notfound-page >= 0.8
    sphinx-reredirects
    sphinx_rtd_theme >= 1.0.0
    sphinxcontrib-bibtex
    towncrier >= 22.8.0
developer =
    # install everything for developers
    # ought to functionally mirror requirements.txt
    %(docs)s
    %(extras)s
    %(tests)s
all =
    # The installation option of `pip install plasmapy[all]` has been
    # deprecated since v0.8. Instead use `pip install plasmapy` or
    # `pip install plasmapy[developer]`.
    %(extras)s

[options.packages.find]
exclude = docs/automodapi

[options.package_data]
plasmapy.particles.data = *
plasmapy.tests = coveragerc
plasmapy.utils.calculator = *

[options.entry_points]
console_scripts =
    plasma-calculator = plasmapy.utils.calculator:main

[build_docs]
source-dir = docs
build-dir = docs/_build
all_files = 1

[tool:pytest]
minversion = 5.1
testpaths = "plasmapy"
norecursedirs = "build" "docs/"
doctest_optionflags =
    NORMALIZE_WHITESPACE
    ELLIPSIS
    NUMBER
addopts = --doctest-modules --doctest-continue-on-failure
filterwarnings =
    ignore:.*Creating a LegacyVersion.*:DeprecationWarning
looponfailroots =
    plasmapy

[flake8]
convention = numpy
# Checks marked as TODO should be eventually enabled,
# but are failing right now. These are *great*
# first contributions. ;)
# Checks not marked by TODO *maybe* should be
# eventually enabled ― ask!
extend-ignore =
    D105,
    D107,
    # Ignoring D202 allows blank lines to be put on either side of code "paragraphs" at the beginning of a function.
    D202,
    # D205 and D400 are ignored to allow the "one-liner" to exceed one
    # line, which is sometimes necessary for even concise descriptions of plasma
    # physics functions and classes.
    D205,
    # D302 is unnecessary as we are using Python 3.6+.
    D302,
    # D205 and D400 are ignored to allow the "one-liner" to exceed one
    # line, which is sometimes necessary for even concise descriptions of plasma
    # physics functions and classes.
    D400,
    # D403: First word of the first line should be properly capitalized ('Latex', not 'LaTeX') # Dominik: good job, pydocstyle /s
    D403,
    # E203 something something whitespace? TODO check again
    E203,
    E501,
    # E731 do not assign a lambda, use a def - Dominik: disagreed, lambdas have uses
    E731,
    F401,
    F405,
    # W605 invalid escape sequence,
    W605,
    RST210,
    RST213,
    # RST305 so that ReST substitutions in a different file can be used
    RST305,
    RST306,
    # TC003 to allow long messages to be specified outside the exception class
    TC003
exclude =
    extern,
    sphinx,
    *test*,
    *parsetab.py,
    conftest.py,
    docs/conf.py,
    setup.py,
    .jupyter
# Use rst-roles and rst-directives to list roles and directives from
# Sphinx and its extensions so that they don't get flagged when using
# flake8-rst-docstrings.
rst-roles =
    abbr
    any
    attr
    cite
    cite:ct
    cite:cts
    cite:p
    cite:ps
    cite:t
    cite:ts
    class
    command
    commit
    confval
    data
    dfn
    doc
    download
    envvar
    eq
    event
    exc
    file
    func
    guilabel
    issue
    kbd
    keyword
    makevar
    manpage
    menuselection
    meth
    mod
    numref
    option
    orcid
    pep
    pr
    program
    ref
    regexp
    rst:dir
    samp
    term
    token
    user
    wikipedia
rst-directives =
    codeauthor
    confval
    deprecated
    event
    highlight
    hlist
    index
    literalinclude
    nbgallery
    only
    rst:directive
    samp
    sectionauthor
    seealso
    tabularcolumns
    todo
    versionadded
    versionchanged
enable-extensions =
    # Look for strings that have {} in them but aren't f-strings.
    # If there is a false positive from this in a file, put that in
    # per-file-ignores.
    FS003
per-file-ignores =
    plasmapy/__init__.py:FS003
    plasmapy/analysis/fit_functions.py:RST499
    # The nullpoint.py ignore is temporary pending #1554
    plasmapy/analysis/nullpoint.py:SIM102,SIM103
    plasmapy/diagnostics/charged_particle_radiography.py:FS003
    plasmapy/formulary/__init__.py:E402,F403
    plasmapy/formulary/collisions/__init__.py:E402,F403
    plasmapy/formulary/collisions/lengths.py:SIM114
    # The decorators.py ignore is temporary pending #1057
    plasmapy/particles/decorators.py:SIM102
    plasmapy/particles/ionization_state_collection.py:SIM102

[coverage:run]
omit =
    ci-helpers/*
    */tests/*
    plasmapy/utils/calculator/*
    plasmapy/version.py

[coverage:report]
exclude_lines =
    coverage: ignore
    ImportError
    ModuleNotFoundError
    @vectorize
    @numba.vectorize
    @numba.jit
    @jit
    @numba.njit
    @njit
    @abstractmethod

[codespell]
skip = *.png,*cache*,*egg*,.git,.hypothesis,.idea,.tox,_build,*charged_particle*.ipynb,venv
ignore-words-list =
    aci,
    afe,
    ans,
    ba,
    bu,
    circularly,
    ded,
    dne,
    ect,
    explin,
    fo,
    fof,
    gud,
    hax,
    hist,
    hve,
    nd,
    noo,
    nwo,
    ot,
    recuse,
    ro,
    te,
    ue,
    ue,
    windo