From 91d61b01b6656e9da48cabe4f42530cc2a66ed12 Mon Sep 17 00:00:00 2001 From: Remco de Boer <29308176+redeboer@users.noreply.github.com> Date: Thu, 24 Aug 2023 23:33:40 +0200 Subject: [PATCH] DOC: add `CITATION.cff` (#356) * MAINT: update pip constraints and pre-commit --------- Co-authored-by: GitHub Co-authored-by: pre-commit-ci[bot] <66853113+pre-commit-ci[bot]@users.noreply.github.com> --- .constraints/py3.10.txt | 69 ++++++++++++++++++------------------- .constraints/py3.11.txt | 67 ++++++++++++++++++------------------ .constraints/py3.7.txt | 30 ++++++++-------- .constraints/py3.8.txt | 59 ++++++++++++++++---------------- .constraints/py3.9.txt | 69 ++++++++++++++++++------------------- .cspell.json | 2 +- .pre-commit-config.yaml | 26 ++++++++++---- .vscode/settings.json | 1 + .zenodo.json | 76 ----------------------------------------- CITATION.cff | 40 ++++++++++++++++++++++ 10 files changed, 207 insertions(+), 232 deletions(-) delete mode 100644 .zenodo.json create mode 100644 CITATION.cff diff --git a/.constraints/py3.10.txt b/.constraints/py3.10.txt index b74dad506..43a9db7e3 100644 --- a/.constraints/py3.10.txt +++ b/.constraints/py3.10.txt @@ -7,7 +7,7 @@ accessible-pygments==0.0.4 alabaster==0.7.13 anyio==3.7.1 -argon2-cffi==21.3.0 +argon2-cffi==23.1.0 argon2-cffi-bindings==21.2.0 arrow==1.2.3 asttokens==2.2.1 @@ -21,33 +21,33 @@ bleach==6.0.0 cachetools==5.3.1 certifi==2023.7.22 cffi==1.15.1 -cfgv==3.3.1 +cfgv==3.4.0 chardet==5.2.0 charset-normalizer==3.2.0 -click==8.1.6 +click==8.1.7 colorama==0.4.6 comm==0.1.4 contourpy==1.1.0 -coverage==7.2.7 +coverage==7.3.0 cycler==0.11.0 -debugpy==1.6.7 +debugpy==1.6.7.post1 decorator==5.1.1 defusedxml==0.7.1 deprecated==1.2.14 distlib==0.3.7 -docutils==0.19 -exceptiongroup==1.1.2 +docutils==0.17.1 +exceptiongroup==1.1.3 execnet==2.0.2 executing==1.2.0 fastjsonschema==2.18.0 filelock==3.12.2 -fonttools==4.42.0 +fonttools==4.42.1 fqdn==1.5.1 gprof2dot==2022.7.29 graphviz==0.20.1 greenlet==2.0.2 hepunits==2.3.2 -identify==2.5.26 +identify==2.5.27 idna==3.4 imagesize==1.4.1 importlib-metadata==6.8.0 @@ -69,15 +69,15 @@ jupyter-client==8.3.0 jupyter-core==5.3.1 jupyter-events==0.7.0 jupyter-lsp==2.2.0 -jupyter-server==2.7.0 +jupyter-server==2.7.2 jupyter-server-terminals==0.4.4 -jupyterlab==4.0.4 +jupyterlab==4.0.5 jupyterlab-code-formatter==2.2.1 jupyterlab-myst==2.0.1 jupyterlab-pygments==0.2.2 jupyterlab-server==2.24.0 jupyterlab-widgets==3.0.8 -kiwisolver==1.4.4 +kiwisolver==1.4.5 latexcodec==2.0.1 livereload==2.6.3 markdown-it-py==2.2.0 @@ -89,14 +89,14 @@ mdurl==0.1.2 mistune==3.0.1 mpl-interactions==0.23.1 mpmath==1.3.0 -mypy==1.4.1 +mypy==1.5.1 mypy-extensions==1.0.0 myst-nb==0.17.2 myst-parser==0.18.1 nbclient==0.6.8 -nbconvert==7.7.3 +nbconvert==7.7.4 nbformat==5.9.2 -nbmake==1.4.1 +nbmake==1.4.3 nest-asyncio==1.5.7 nodeenv==1.8.0 notebook-shim==0.2.3 @@ -119,13 +119,12 @@ psutil==5.9.5 ptyprocess==0.7.0 pure-eval==0.2.2 pybtex==0.24.0 -pybtex-docutils==1.0.2 +pybtex-docutils==1.0.3 pycparser==2.21 -pydantic==1.10.12 pydata-sphinx-theme==0.13.3 pygments==2.16.1 pyparsing==3.0.9 -pyproject-api==1.5.3 +pyproject-api==1.5.4 pytest==7.4.0 pytest-cov==4.1.0 pytest-profiling==1.7.0 @@ -134,7 +133,7 @@ python-constraint==1.4.0 python-dateutil==2.8.2 python-json-logger==2.0.7 pyyaml==6.0.1 -pyzmq==25.1.0 +pyzmq==25.1.1 qrules==0.9.8 referencing==0.30.2 requests==2.31.0 @@ -142,7 +141,7 @@ rfc3339-validator==0.1.4 rfc3986-validator==0.1.1 rich==13.5.2 rpds-py==0.9.2 -ruff==0.0.282 +ruff==0.0.285 send2trash==1.8.2 six==1.16.0 sniffio==1.3.0 @@ -157,39 +156,39 @@ sphinx-copybutton==0.5.2 sphinx-design==0.5.0 sphinx-thebe==0.2.1 sphinx-togglebutton==0.3.2 -sphinxcontrib-applehelp==1.0.4 -sphinxcontrib-bibtex==2.5.0 -sphinxcontrib-devhelp==1.0.2 +sphinxcontrib-applehelp==1.0.7 +sphinxcontrib-bibtex==2.6.0 +sphinxcontrib-devhelp==1.0.5 sphinxcontrib-hep-pdgref==0.1.4 -sphinxcontrib-htmlhelp==2.0.1 +sphinxcontrib-htmlhelp==2.0.4 sphinxcontrib-jsmath==1.0.1 -sphinxcontrib-qthelp==1.0.3 -sphinxcontrib-serializinghtml==1.1.5 -sqlalchemy==2.0.19 +sphinxcontrib-qthelp==1.0.6 +sphinxcontrib-serializinghtml==1.1.9 +sqlalchemy==2.0.20 stack-data==0.6.2 sympy==1.12 tabulate==0.9.0 terminado==0.17.1 tinycss2==1.2.1 tomli==2.0.1 -tornado==6.3.2 -tox==4.6.4 -tqdm==4.65.0 +tornado==6.3.3 +tox==4.10.0 +tqdm==4.66.1 traitlets==5.9.0 -types-docutils==0.20.0.1 +types-docutils==0.20.0.3 types-pkg-resources==0.1.3 types-requests==2.31.0.2 -types-setuptools==68.0.0.3 +types-setuptools==68.1.0.0 types-urllib3==1.26.25.14 typing-extensions==4.7.1 uri-template==1.3.0 urllib3==2.0.4 -virtualenv==20.24.2 +virtualenv==20.24.3 wcwidth==0.2.6 webcolors==1.13 webencodings==0.5.1 -websocket-client==1.6.1 -wheel==0.41.1 +websocket-client==1.6.2 +wheel==0.41.2 widgetsnbextension==4.0.8 wrapt==1.15.0 zipp==3.16.2 diff --git a/.constraints/py3.11.txt b/.constraints/py3.11.txt index 7cdee02e5..67dd563d8 100644 --- a/.constraints/py3.11.txt +++ b/.constraints/py3.11.txt @@ -7,7 +7,7 @@ accessible-pygments==0.0.4 alabaster==0.7.13 anyio==3.7.1 -argon2-cffi==21.3.0 +argon2-cffi==23.1.0 argon2-cffi-bindings==21.2.0 arrow==1.2.3 asttokens==2.2.1 @@ -21,32 +21,32 @@ bleach==6.0.0 cachetools==5.3.1 certifi==2023.7.22 cffi==1.15.1 -cfgv==3.3.1 +cfgv==3.4.0 chardet==5.2.0 charset-normalizer==3.2.0 -click==8.1.6 +click==8.1.7 colorama==0.4.6 comm==0.1.4 contourpy==1.1.0 -coverage==7.2.7 +coverage==7.3.0 cycler==0.11.0 -debugpy==1.6.7 +debugpy==1.6.7.post1 decorator==5.1.1 defusedxml==0.7.1 deprecated==1.2.14 distlib==0.3.7 -docutils==0.19 +docutils==0.17.1 execnet==2.0.2 executing==1.2.0 fastjsonschema==2.18.0 filelock==3.12.2 -fonttools==4.42.0 +fonttools==4.42.1 fqdn==1.5.1 gprof2dot==2022.7.29 graphviz==0.20.1 greenlet==2.0.2 hepunits==2.3.2 -identify==2.5.26 +identify==2.5.27 idna==3.4 imagesize==1.4.1 importlib-metadata==6.8.0 @@ -68,15 +68,15 @@ jupyter-client==8.3.0 jupyter-core==5.3.1 jupyter-events==0.7.0 jupyter-lsp==2.2.0 -jupyter-server==2.7.0 +jupyter-server==2.7.2 jupyter-server-terminals==0.4.4 -jupyterlab==4.0.4 +jupyterlab==4.0.5 jupyterlab-code-formatter==2.2.1 jupyterlab-myst==2.0.1 jupyterlab-pygments==0.2.2 jupyterlab-server==2.24.0 jupyterlab-widgets==3.0.8 -kiwisolver==1.4.4 +kiwisolver==1.4.5 latexcodec==2.0.1 livereload==2.6.3 markdown-it-py==2.2.0 @@ -88,14 +88,14 @@ mdurl==0.1.2 mistune==3.0.1 mpl-interactions==0.23.1 mpmath==1.3.0 -mypy==1.4.1 +mypy==1.5.1 mypy-extensions==1.0.0 myst-nb==0.17.2 myst-parser==0.18.1 nbclient==0.6.8 -nbconvert==7.7.3 +nbconvert==7.7.4 nbformat==5.9.2 -nbmake==1.4.1 +nbmake==1.4.3 nest-asyncio==1.5.7 nodeenv==1.8.0 notebook-shim==0.2.3 @@ -118,13 +118,12 @@ psutil==5.9.5 ptyprocess==0.7.0 pure-eval==0.2.2 pybtex==0.24.0 -pybtex-docutils==1.0.2 +pybtex-docutils==1.0.3 pycparser==2.21 -pydantic==1.10.12 pydata-sphinx-theme==0.13.3 pygments==2.16.1 pyparsing==3.0.9 -pyproject-api==1.5.3 +pyproject-api==1.5.4 pytest==7.4.0 pytest-cov==4.1.0 pytest-profiling==1.7.0 @@ -133,7 +132,7 @@ python-constraint==1.4.0 python-dateutil==2.8.2 python-json-logger==2.0.7 pyyaml==6.0.1 -pyzmq==25.1.0 +pyzmq==25.1.1 qrules==0.9.8 referencing==0.30.2 requests==2.31.0 @@ -141,7 +140,7 @@ rfc3339-validator==0.1.4 rfc3986-validator==0.1.1 rich==13.5.2 rpds-py==0.9.2 -ruff==0.0.282 +ruff==0.0.285 send2trash==1.8.2 six==1.16.0 sniffio==1.3.0 @@ -156,38 +155,38 @@ sphinx-copybutton==0.5.2 sphinx-design==0.5.0 sphinx-thebe==0.2.1 sphinx-togglebutton==0.3.2 -sphinxcontrib-applehelp==1.0.4 -sphinxcontrib-bibtex==2.5.0 -sphinxcontrib-devhelp==1.0.2 +sphinxcontrib-applehelp==1.0.7 +sphinxcontrib-bibtex==2.6.0 +sphinxcontrib-devhelp==1.0.5 sphinxcontrib-hep-pdgref==0.1.4 -sphinxcontrib-htmlhelp==2.0.1 +sphinxcontrib-htmlhelp==2.0.4 sphinxcontrib-jsmath==1.0.1 -sphinxcontrib-qthelp==1.0.3 -sphinxcontrib-serializinghtml==1.1.5 -sqlalchemy==2.0.19 +sphinxcontrib-qthelp==1.0.6 +sphinxcontrib-serializinghtml==1.1.9 +sqlalchemy==2.0.20 stack-data==0.6.2 sympy==1.12 tabulate==0.9.0 terminado==0.17.1 tinycss2==1.2.1 -tornado==6.3.2 -tox==4.6.4 -tqdm==4.65.0 +tornado==6.3.3 +tox==4.10.0 +tqdm==4.66.1 traitlets==5.9.0 -types-docutils==0.20.0.1 +types-docutils==0.20.0.3 types-pkg-resources==0.1.3 types-requests==2.31.0.2 -types-setuptools==68.0.0.3 +types-setuptools==68.1.0.0 types-urllib3==1.26.25.14 typing-extensions==4.7.1 uri-template==1.3.0 urllib3==2.0.4 -virtualenv==20.24.2 +virtualenv==20.24.3 wcwidth==0.2.6 webcolors==1.13 webencodings==0.5.1 -websocket-client==1.6.1 -wheel==0.41.1 +websocket-client==1.6.2 +wheel==0.41.2 widgetsnbextension==4.0.8 wrapt==1.15.0 zipp==3.16.2 diff --git a/.constraints/py3.7.txt b/.constraints/py3.7.txt index 7494863bf..5be73ecc1 100644 --- a/.constraints/py3.7.txt +++ b/.constraints/py3.7.txt @@ -9,7 +9,7 @@ aiofiles==22.1.0 aiosqlite==0.19.0 alabaster==0.7.13 anyio==3.7.1 -argon2-cffi==21.3.0 +argon2-cffi==23.1.0 argon2-cffi-bindings==21.2.0 arrow==1.2.3 attrs==23.1.0 @@ -25,19 +25,19 @@ cffi==1.15.1 cfgv==3.3.1 chardet==5.2.0 charset-normalizer==3.2.0 -click==8.1.6 +click==8.1.7 colorama==0.4.6 comm==0.1.4 coverage==7.2.7 cycler==0.11.0 -debugpy==1.6.7 +debugpy==1.6.7.post1 decorator==5.1.1 defusedxml==0.7.1 deprecated==1.2.14 distlib==0.3.7 -docutils==0.19 +docutils==0.17.1 entrypoints==0.4 -exceptiongroup==1.1.2 +exceptiongroup==1.1.3 execnet==2.0.2 fastjsonschema==2.18.0 filelock==3.12.2 @@ -78,7 +78,7 @@ jupyterlab-myst==1.2.0 jupyterlab-pygments==0.2.2 jupyterlab-server==2.24.0 jupyterlab-widgets==3.0.8 -kiwisolver==1.4.4 +kiwisolver==1.4.5 latexcodec==2.0.1 livereload==2.6.3 markdown-it-py==2.2.0 @@ -121,7 +121,7 @@ prompt-toolkit==3.0.39 psutil==5.9.5 ptyprocess==0.7.0 pybtex==0.24.0 -pybtex-docutils==1.0.2 +pybtex-docutils==1.0.3 pycparser==2.21 pydantic==1.10.12 pydata-sphinx-theme==0.13.3 @@ -144,7 +144,7 @@ requests==2.31.0 rfc3339-validator==0.1.4 rfc3986-validator==0.1.1 rich==13.5.2 -ruff==0.0.282 +ruff==0.0.285 send2trash==1.8.2 singledispatchmethod==1.0 ; python_version < "3.8.0" six==1.16.0 @@ -161,7 +161,7 @@ sphinx-design==0.4.1 sphinx-thebe==0.2.1 sphinx-togglebutton==0.3.2 sphinxcontrib-applehelp==1.0.2 -sphinxcontrib-bibtex==2.5.0 +sphinxcontrib-bibtex==2.6.0 sphinxcontrib-devhelp==1.0.2 sphinxcontrib-hep-pdgref==0.1.4 sphinxcontrib-htmlhelp==2.0.0 @@ -175,24 +175,24 @@ terminado==0.17.1 tinycss2==1.2.1 tomli==2.0.1 tornado==6.2 -tox==4.6.4 -tqdm==4.65.0 +tox==4.8.0 +tqdm==4.66.1 traitlets==5.9.0 typed-ast==1.5.5 -types-docutils==0.20.0.1 +types-docutils==0.20.0.3 types-pkg-resources==0.1.3 types-requests==2.31.0.2 -types-setuptools==68.0.0.3 +types-setuptools==68.1.0.0 types-urllib3==1.26.25.14 typing-extensions==4.7.1 ; python_version < "3.8.0" uri-template==1.3.0 urllib3==2.0.4 -virtualenv==20.24.2 +virtualenv==20.24.3 wcwidth==0.2.6 webcolors==1.13 webencodings==0.5.1 websocket-client==1.6.1 -wheel==0.41.1 +wheel==0.41.2 widgetsnbextension==4.0.8 wrapt==1.15.0 y-py==0.5.9 diff --git a/.constraints/py3.8.txt b/.constraints/py3.8.txt index 49f8de36f..bf3921237 100644 --- a/.constraints/py3.8.txt +++ b/.constraints/py3.8.txt @@ -7,7 +7,7 @@ accessible-pygments==0.0.4 alabaster==0.7.13 anyio==3.7.1 -argon2-cffi==21.3.0 +argon2-cffi==23.1.0 argon2-cffi-bindings==21.2.0 arrow==1.2.3 asttokens==2.2.1 @@ -21,33 +21,33 @@ bleach==6.0.0 cachetools==5.3.1 certifi==2023.7.22 cffi==1.15.1 -cfgv==3.3.1 +cfgv==3.4.0 chardet==5.2.0 charset-normalizer==3.2.0 -click==8.1.6 +click==8.1.7 colorama==0.4.6 comm==0.1.4 contourpy==1.1.0 -coverage==7.2.7 +coverage==7.3.0 cycler==0.11.0 -debugpy==1.6.7 +debugpy==1.6.7.post1 decorator==5.1.1 defusedxml==0.7.1 deprecated==1.2.14 distlib==0.3.7 -docutils==0.19 -exceptiongroup==1.1.2 +docutils==0.17.1 +exceptiongroup==1.1.3 execnet==2.0.2 executing==1.2.0 fastjsonschema==2.18.0 filelock==3.12.2 -fonttools==4.42.0 +fonttools==4.42.1 fqdn==1.5.1 gprof2dot==2022.7.29 graphviz==0.20.1 greenlet==2.0.2 hepunits==2.3.2 -identify==2.5.26 +identify==2.5.27 idna==3.4 imagesize==1.4.1 importlib-metadata==6.8.0 @@ -70,15 +70,15 @@ jupyter-client==8.3.0 jupyter-core==5.3.1 jupyter-events==0.7.0 jupyter-lsp==2.2.0 -jupyter-server==2.7.0 +jupyter-server==2.7.2 jupyter-server-terminals==0.4.4 -jupyterlab==4.0.4 +jupyterlab==4.0.5 jupyterlab-code-formatter==2.2.1 jupyterlab-myst==2.0.1 jupyterlab-pygments==0.2.2 jupyterlab-server==2.24.0 jupyterlab-widgets==3.0.8 -kiwisolver==1.4.4 +kiwisolver==1.4.5 latexcodec==2.0.1 livereload==2.6.3 markdown-it-py==2.2.0 @@ -90,14 +90,14 @@ mdurl==0.1.2 mistune==3.0.1 mpl-interactions==0.23.1 mpmath==1.3.0 -mypy==1.4.1 +mypy==1.5.1 mypy-extensions==1.0.0 myst-nb==0.17.2 myst-parser==0.18.1 nbclient==0.6.8 -nbconvert==7.7.3 +nbconvert==7.7.4 nbformat==5.9.2 -nbmake==1.4.1 +nbmake==1.4.3 nest-asyncio==1.5.7 nodeenv==1.8.0 notebook-shim==0.2.3 @@ -121,13 +121,12 @@ psutil==5.9.5 ptyprocess==0.7.0 pure-eval==0.2.2 pybtex==0.24.0 -pybtex-docutils==1.0.2 +pybtex-docutils==1.0.3 pycparser==2.21 -pydantic==1.10.12 pydata-sphinx-theme==0.13.3 pygments==2.16.1 pyparsing==3.0.9 -pyproject-api==1.5.3 +pyproject-api==1.5.4 pytest==7.4.0 pytest-cov==4.1.0 pytest-profiling==1.7.0 @@ -137,7 +136,7 @@ python-dateutil==2.8.2 python-json-logger==2.0.7 pytz==2023.3 pyyaml==6.0.1 -pyzmq==25.1.0 +pyzmq==25.1.1 qrules==0.9.8 referencing==0.30.2 requests==2.31.0 @@ -145,7 +144,7 @@ rfc3339-validator==0.1.4 rfc3986-validator==0.1.1 rich==13.5.2 rpds-py==0.9.2 -ruff==0.0.282 +ruff==0.0.285 send2trash==1.8.2 six==1.16.0 sniffio==1.3.0 @@ -161,38 +160,38 @@ sphinx-design==0.5.0 sphinx-thebe==0.2.1 sphinx-togglebutton==0.3.2 sphinxcontrib-applehelp==1.0.4 -sphinxcontrib-bibtex==2.5.0 +sphinxcontrib-bibtex==2.6.0 sphinxcontrib-devhelp==1.0.2 sphinxcontrib-hep-pdgref==0.1.4 sphinxcontrib-htmlhelp==2.0.1 sphinxcontrib-jsmath==1.0.1 sphinxcontrib-qthelp==1.0.3 sphinxcontrib-serializinghtml==1.1.5 -sqlalchemy==2.0.19 +sqlalchemy==2.0.20 stack-data==0.6.2 sympy==1.12 tabulate==0.9.0 terminado==0.17.1 tinycss2==1.2.1 tomli==2.0.1 -tornado==6.3.2 -tox==4.6.4 -tqdm==4.65.0 +tornado==6.3.3 +tox==4.10.0 +tqdm==4.66.1 traitlets==5.9.0 -types-docutils==0.20.0.1 +types-docutils==0.20.0.3 types-pkg-resources==0.1.3 types-requests==2.31.0.2 -types-setuptools==68.0.0.3 +types-setuptools==68.1.0.0 types-urllib3==1.26.25.14 typing-extensions==4.7.1 uri-template==1.3.0 urllib3==2.0.4 -virtualenv==20.24.2 +virtualenv==20.24.3 wcwidth==0.2.6 webcolors==1.13 webencodings==0.5.1 -websocket-client==1.6.1 -wheel==0.41.1 +websocket-client==1.6.2 +wheel==0.41.2 widgetsnbextension==4.0.8 wrapt==1.15.0 zipp==3.16.2 diff --git a/.constraints/py3.9.txt b/.constraints/py3.9.txt index 721bae409..17bb3870c 100644 --- a/.constraints/py3.9.txt +++ b/.constraints/py3.9.txt @@ -7,7 +7,7 @@ accessible-pygments==0.0.4 alabaster==0.7.13 anyio==3.7.1 -argon2-cffi==21.3.0 +argon2-cffi==23.1.0 argon2-cffi-bindings==21.2.0 arrow==1.2.3 asttokens==2.2.1 @@ -21,33 +21,33 @@ bleach==6.0.0 cachetools==5.3.1 certifi==2023.7.22 cffi==1.15.1 -cfgv==3.3.1 +cfgv==3.4.0 chardet==5.2.0 charset-normalizer==3.2.0 -click==8.1.6 +click==8.1.7 colorama==0.4.6 comm==0.1.4 contourpy==1.1.0 -coverage==7.2.7 +coverage==7.3.0 cycler==0.11.0 -debugpy==1.6.7 +debugpy==1.6.7.post1 decorator==5.1.1 defusedxml==0.7.1 deprecated==1.2.14 distlib==0.3.7 -docutils==0.19 -exceptiongroup==1.1.2 +docutils==0.17.1 +exceptiongroup==1.1.3 execnet==2.0.2 executing==1.2.0 fastjsonschema==2.18.0 filelock==3.12.2 -fonttools==4.42.0 +fonttools==4.42.1 fqdn==1.5.1 gprof2dot==2022.7.29 graphviz==0.20.1 greenlet==2.0.2 hepunits==2.3.2 -identify==2.5.26 +identify==2.5.27 idna==3.4 imagesize==1.4.1 importlib-metadata==6.8.0 @@ -70,15 +70,15 @@ jupyter-client==8.3.0 jupyter-core==5.3.1 jupyter-events==0.7.0 jupyter-lsp==2.2.0 -jupyter-server==2.7.0 +jupyter-server==2.7.2 jupyter-server-terminals==0.4.4 -jupyterlab==4.0.4 +jupyterlab==4.0.5 jupyterlab-code-formatter==2.2.1 jupyterlab-myst==2.0.1 jupyterlab-pygments==0.2.2 jupyterlab-server==2.24.0 jupyterlab-widgets==3.0.8 -kiwisolver==1.4.4 +kiwisolver==1.4.5 latexcodec==2.0.1 livereload==2.6.3 markdown-it-py==2.2.0 @@ -90,14 +90,14 @@ mdurl==0.1.2 mistune==3.0.1 mpl-interactions==0.23.1 mpmath==1.3.0 -mypy==1.4.1 +mypy==1.5.1 mypy-extensions==1.0.0 myst-nb==0.17.2 myst-parser==0.18.1 nbclient==0.6.8 -nbconvert==7.7.3 +nbconvert==7.7.4 nbformat==5.9.2 -nbmake==1.4.1 +nbmake==1.4.3 nest-asyncio==1.5.7 nodeenv==1.8.0 notebook-shim==0.2.3 @@ -120,13 +120,12 @@ psutil==5.9.5 ptyprocess==0.7.0 pure-eval==0.2.2 pybtex==0.24.0 -pybtex-docutils==1.0.2 +pybtex-docutils==1.0.3 pycparser==2.21 -pydantic==1.10.12 pydata-sphinx-theme==0.13.3 pygments==2.16.1 pyparsing==3.0.9 -pyproject-api==1.5.3 +pyproject-api==1.5.4 pytest==7.4.0 pytest-cov==4.1.0 pytest-profiling==1.7.0 @@ -135,7 +134,7 @@ python-constraint==1.4.0 python-dateutil==2.8.2 python-json-logger==2.0.7 pyyaml==6.0.1 -pyzmq==25.1.0 +pyzmq==25.1.1 qrules==0.9.8 referencing==0.30.2 requests==2.31.0 @@ -143,7 +142,7 @@ rfc3339-validator==0.1.4 rfc3986-validator==0.1.1 rich==13.5.2 rpds-py==0.9.2 -ruff==0.0.282 +ruff==0.0.285 send2trash==1.8.2 six==1.16.0 sniffio==1.3.0 @@ -158,39 +157,39 @@ sphinx-copybutton==0.5.2 sphinx-design==0.5.0 sphinx-thebe==0.2.1 sphinx-togglebutton==0.3.2 -sphinxcontrib-applehelp==1.0.4 -sphinxcontrib-bibtex==2.5.0 -sphinxcontrib-devhelp==1.0.2 +sphinxcontrib-applehelp==1.0.7 +sphinxcontrib-bibtex==2.6.0 +sphinxcontrib-devhelp==1.0.5 sphinxcontrib-hep-pdgref==0.1.4 -sphinxcontrib-htmlhelp==2.0.1 +sphinxcontrib-htmlhelp==2.0.4 sphinxcontrib-jsmath==1.0.1 -sphinxcontrib-qthelp==1.0.3 -sphinxcontrib-serializinghtml==1.1.5 -sqlalchemy==2.0.19 +sphinxcontrib-qthelp==1.0.6 +sphinxcontrib-serializinghtml==1.1.9 +sqlalchemy==2.0.20 stack-data==0.6.2 sympy==1.12 tabulate==0.9.0 terminado==0.17.1 tinycss2==1.2.1 tomli==2.0.1 -tornado==6.3.2 -tox==4.6.4 -tqdm==4.65.0 +tornado==6.3.3 +tox==4.10.0 +tqdm==4.66.1 traitlets==5.9.0 -types-docutils==0.20.0.1 +types-docutils==0.20.0.3 types-pkg-resources==0.1.3 types-requests==2.31.0.2 -types-setuptools==68.0.0.3 +types-setuptools==68.1.0.0 types-urllib3==1.26.25.14 typing-extensions==4.7.1 uri-template==1.3.0 urllib3==2.0.4 -virtualenv==20.24.2 +virtualenv==20.24.3 wcwidth==0.2.6 webcolors==1.13 webencodings==0.5.1 -websocket-client==1.6.1 -wheel==0.41.1 +websocket-client==1.6.2 +wheel==0.41.2 widgetsnbextension==4.0.8 wrapt==1.15.0 zipp==3.16.2 diff --git a/.cspell.json b/.cspell.json index e0b089700..f403bb878 100644 --- a/.cspell.json +++ b/.cspell.json @@ -32,7 +32,7 @@ ".readthedocs.yml", ".vscode/*", ".vscode/.gitignore", - ".zenodo.json", + "CITATION.cff", "codecov.yml", "Dockerfile", "docs/_templates/*", diff --git a/.pre-commit-config.yaml b/.pre-commit-config.yaml index 392aa8da3..df2a0e758 100644 --- a/.pre-commit-config.yaml +++ b/.pre-commit-config.yaml @@ -2,6 +2,7 @@ ci: autoupdate_commit_msg: "MAINT: update pip constraints and pre-commit" autoupdate_schedule: quarterly # already done by requirements-cron.yml skip: + - check-jsonschema - mypy - pyright - taplo @@ -37,7 +38,7 @@ repos: - id: trailing-whitespace - repo: https://github.com/ComPWA/repo-maintenance - rev: 0.0.195 + rev: 0.0.197 hooks: - id: check-dev-files args: @@ -72,12 +73,25 @@ repos: - id: black - repo: https://github.com/asottile/blacken-docs - rev: 1.15.0 + rev: 1.16.0 hooks: - id: blacken-docs + - repo: https://github.com/python-jsonschema/check-jsonschema + rev: 0.24.1 + hooks: + - id: check-jsonschema + name: Check CITATION.cff + args: + - --default-filetype + - yaml + - --schemafile + - https://citation-file-format.github.io/1.2.0/schema.json + - CITATION.cff + pass_filenames: false + - repo: https://github.com/streetsidesoftware/cspell-cli - rev: v6.31.1 + rev: v7.0.1 hooks: - id: cspell @@ -132,12 +146,12 @@ repos: metadata.vscode - repo: https://github.com/pre-commit/mirrors-prettier - rev: v3.0.1 + rev: v3.0.2 hooks: - id: prettier - repo: https://github.com/ComPWA/mirrors-pyright - rev: v1.1.320 + rev: v1.1.324 hooks: - id: pyright @@ -149,7 +163,7 @@ repos: - --py37-plus - repo: https://github.com/astral-sh/ruff-pre-commit - rev: v0.0.282 + rev: v0.0.285 hooks: - id: ruff args: diff --git a/.vscode/settings.json b/.vscode/settings.json index e65fc7a38..4bfee1c60 100644 --- a/.vscode/settings.json +++ b/.vscode/settings.json @@ -64,6 +64,7 @@ ".constraints/*.txt": true }, "yaml.schemas": { + "https://citation-file-format.github.io/1.2.0/schema.json": "CITATION.cff", "https://json.schemastore.org/github-workflow.json": "./.github/workflows/requirements.yml", "https://raw.githubusercontent.com/readthedocs/readthedocs.org/master/readthedocs/rtd_tests/fixtures/spec/v2/schema.yml": ".readthedocs.yml" } diff --git a/.zenodo.json b/.zenodo.json deleted file mode 100644 index 547966d3a..000000000 --- a/.zenodo.json +++ /dev/null @@ -1,76 +0,0 @@ -{ - "access_right": "open", - "creators": [ - { - "affiliation": "Ruhr University Bochum", - "name": "Fritsch, Miriam" - }, - { - "affiliation": "Ruhr University Bochum", - "name": "Pfl\u00fcger, Stefan" - }, - { - "affiliation": "Ruhr University Bochum", - "name": "de Boer, Remco" - }, - { - "affiliation": "Ruhr University Bochum", - "name": "J\u00e4ger, Sebastian" - }, - { - "affiliation": "Ruhr University Bochum", - "name": "Wollenberg, Leonard" - }, - { - "affiliation": "Johannes Gutenberg University Mainz", - "name": "Gradl, Wolfgang" - }, - { - "affiliation": "GSI Helmholtzzentrum f\u00fcr Schwerionenforschung", - "name": "Peters, Klaus" - } - ], - "description": "

AmpForm is a Python library of spin formalisms and dynamics with which you can automatically formulate symbolic amplitude models for Partial Wave Analysis. The resulting amplitude models are formulated with SymPy (a Computer Algebra System). This not only makes it easy to inspect and visualize the resulting amplitude models, but also means the amplitude models can be used as templates for faster computational back-ends (see TensorWaves).

", - "keywords": [ - "particle physics", - "amplitude analysis", - "partial wave analysis", - "sympy", - "computer algebra system" - ], - "language": "eng", - "license": "GPL-3.0-or-later", - "references": [ - "Meurer, Smith et al. (2017). \"SymPy: symbolic computing in Python\". PeerJ Computer Science 3:e103. https://doi.org/10.7717/peerj-cs.103.", - "Pfl\u00fcger, de Boer et al. (2021). \"ComPWA/qrules: Rule-based particle reaction problem solver on a quantum number level\". https://doi.org/10.5281/zenodo.5526360.", - "Pfl\u00fcger, de Boer et al. (2021). \"ComPWA/tensorwaves: Python fitter package for multiple computational back-ends\". https://doi.org/10.5281/zenodo.5526361." - ], - "related_identifiers": [ - { - "scheme": "doi", - "identifier": "10.5281/zenodo.5526648", - "relation": "continues", - "resource_type": "software" - }, - { - "scheme": "doi", - "identifier": "10.5281/zenodo.5526360", - "relation": "references", - "resource_type": "software" - }, - { - "scheme": "doi", - "identifier": "10.5281/zenodo.5526361", - "relation": "references", - "resource_type": "software" - }, - { - "scheme": "doi", - "identifier": "10.7717/peerj-cs.103", - "relation": "references", - "resource_type": "software" - } - ], - "title": "ComPWA/ampform: Automatically generate symbolic amplitude models for Partial Wave Analysis", - "upload_type": "software" -} diff --git a/CITATION.cff b/CITATION.cff new file mode 100644 index 000000000..2b09960cf --- /dev/null +++ b/CITATION.cff @@ -0,0 +1,40 @@ +cff-version: 1.2.0 +message: If you use this software, please cite it as below. +title: >- + ComPWA/ampform: Automatically generate symbolic amplitude models for Partial Wave Analysis +abstract: |- + AmpForm is a Python library of spin formalisms and dynamics with which you can automatically formulate symbolic amplitude models for Partial Wave Analysis. The resulting amplitude models are formulated with [SymPy](https://www.sympy.org/en/index.html) (a Computer Algebra System). This not only makes it easy to inspect and visualize the resulting amplitude models, but also means the amplitude models can be used as templates for faster computational back-ends (see [TensorWaves](https://github.com/ComPWA/tensorwaves)). + +authors: + - family-names: Fritsch + given-names: Miriam + affiliation: Ruhr University Bochum + - family-names: Pflüger + given-names: Stefan + affiliation: Ruhr University Bochum + - family-names: de Boer + given-names: Remco E. + affiliation: Ruhr University Bochum + - family-names: Jäger + given-names: Sebastian + affiliation: Ruhr University Bochum + - family-names: Wollenberg + given-names: Leonard + affiliation: Ruhr University Bochum + - family-names: Gradl + given-names: Wolfgang + affiliation: Johannes Gutenberg University Mainz + - family-names: Peters + given-names: Klaus + affiliation: GSI Helmholtzzentrum für Schwerionenforschung +doi: 10.5281/zenodo.5526648 +keywords: + - particle physics + - amplitude analysis + - partial wave analysis + - sympy + - computer algebra system +license: GPL-3.0-or-later +repository-code: https://github.com/ComPWA/ampform +type: software +url: https://ampform.readthedocs.io