diff --git a/.cspell.json b/.cspell.json index ac35863..cd2b9ae 100644 --- a/.cspell.json +++ b/.cspell.json @@ -85,7 +85,6 @@ "pyplot", "pyright", "realpath", - "redeboer", "rtfd", "rtol", "sdist", diff --git a/.github/release-drafter.yml b/.github/release-drafter.yml index 5a56962..af7a41a 100644 --- a/.github/release-drafter.yml +++ b/.github/release-drafter.yml @@ -34,4 +34,4 @@ sort-direction: ascending template: | $CHANGES - _The full changelog as commits can be found [here](https://github.com/ComPWA/PawianTools/compare/$PREVIOUS_TAG...$NEXT_PATCH_VERSION)._ + _The full changelog as commits can be found [here](https://github.com/RUB-EP1/pawian-tools/compare/$PREVIOUS_TAG...$NEXT_PATCH_VERSION)._ diff --git a/.pre-commit-config.yaml b/.pre-commit-config.yaml index 65dd107..ec569e2 100644 --- a/.pre-commit-config.yaml +++ b/.pre-commit-config.yaml @@ -83,13 +83,14 @@ repos: - --in-place - repo: https://github.com/ComPWA/policy - rev: 0.3.4 + rev: 0.3.5 hooks: - id: check-dev-files args: - --no-prettierrc - --pin-requirements=bimonthly - - --repo-name=PawianTools + - --repo-name=pawian-tools + - --repo-organization=RUB-EP1 - --repo-title=Pawian Tools - repo: https://github.com/streetsidesoftware/cspell-cli diff --git a/README.md b/README.md index a42b62a..d9da2f1 100644 --- a/README.md +++ b/README.md @@ -1,22 +1,22 @@ # Python Tools for Pawian -[![GitHub Pages](https://github.com/redeboer/PawianTools/actions/workflows/ci.yml/badge.svg)](https://github.com/redeboer/PawianTools/actions/workflows/ci.yml) -[![Binder](https://static.mybinder.org/badge_logo.svg)](https://mybinder.org/v2/gh/redeboer/PawianTools/stable?filepath=docs/usage) -[![Google Colab](https://colab.research.google.com/assets/colab-badge.svg)](https://colab.research.google.com/github/redeboer/PawianTools/blob/main) +[![GitHub Pages](https://github.com/RUB-EP1/pawian-tools/actions/workflows/ci.yml/badge.svg)](https://github.com/RUB-EP1/pawian-tools/actions/workflows/ci.yml) +[![Binder](https://static.mybinder.org/badge_logo.svg)](https://mybinder.org/v2/gh/RUB-EP1/pawian-tools/stable?filepath=docs/usage) +[![Google Colab](https://colab.research.google.com/assets/colab-badge.svg)](https://colab.research.google.com/github/RUB-EP1/pawian-tools/blob/main) [![GPLv3+ license](https://img.shields.io/badge/License-GPLv3+-blue.svg)](https://www.gnu.org/licenses/gpl-3.0-standalone.html) -[![GitPod](https://img.shields.io/badge/gitpod-open-blue?logo=gitpod)](https://gitpod.io/#https://github.com/redeboer/PawianTools) +[![GitPod](https://img.shields.io/badge/gitpod-open-blue?logo=gitpod)](https://gitpod.io/#https://github.com/RUB-EP1/pawian-tools) [![code style: prettier](https://img.shields.io/badge/code_style-prettier-ff69b4.svg?style=flat-square)](https://github.com/prettier/prettier) [![Spelling checked](https://img.shields.io/badge/cspell-checked-brightgreen.svg)](https://github.com/streetsidesoftware/cspell/tree/master/packages/cspell)
[![Checked with mypy](http://www.mypy-lang.org/static/mypy_badge.svg)](https://mypy.readthedocs.io)
-[![CI status](https://github.com/redeboer/PawianTools/workflows/CI/badge.svg)](https://github.com/redeboer/PawianTools/actions?query=branch%3Amain+workflow%3ACI) -[![Test coverage](https://codecov.io/gh/redeboer/PawianTools/branch/main/graph/badge.svg)](https://codecov.io/gh/redeboer/PawianTools) +[![CI status](https://github.com/RUB-EP1/pawian-tools/workflows/CI/badge.svg)](https://github.com/RUB-EP1/pawian-tools/actions?query=branch%3Amain+workflow%3ACI) +[![Test coverage](https://codecov.io/gh/RUB-EP1/pawian-tools/branch/main/graph/badge.svg)](https://codecov.io/gh/RUB-EP1/pawian-tools)
[![pre-commit](https://img.shields.io/badge/pre--commit-enabled-brightgreen)](https://github.com/pre-commit/pre-commit) [![Prettier](https://camo.githubusercontent.com/687a8ae8d15f9409617d2cc5a30292a884f6813a/68747470733a2f2f696d672e736869656c64732e696f2f62616467652f636f64655f7374796c652d70726574746965722d6666363962342e7376673f7374796c653d666c61742d737175617265)](https://prettier.io/) [![Ruff](https://img.shields.io/endpoint?url=https://raw.githubusercontent.com/charliermarsh/ruff/main/assets/badge/v2.json)](https://github.com/astral-sh/ruff) -Go to [redeboer.github.io/PawianTools](https://redeboer.github.io/PawianTools) to view +Go to [rub-ep1.github.io/pawian-tools](https://rub-ep1.github.io/pawian-tools) to view the documentation! ## Contribute diff --git a/docs/api.md b/docs/api.md index be4d0a2..58aa57a 100644 --- a/docs/api.md +++ b/docs/api.md @@ -1,6 +1,6 @@ # API -PawianTools consists of the following packages: +Pawian Tools consists of the following packages: ```{toctree} api/boostcfg diff --git a/docs/conf.py b/docs/conf.py index 66a2379..1328ba0 100644 --- a/docs/conf.py +++ b/docs/conf.py @@ -23,9 +23,9 @@ }) BRANCH = get_branch_name() -ORGANIZATION = "redeboer" +ORGANIZATION = "RUB-EP1" PACKAGE = "pawian" -REPO_NAME = "PawianTools" +REPO_NAME = "pawian-tools" REPO_TITLE = REPO_NAME add_module_names = False diff --git a/docs/index.md b/docs/index.md index b5ffcb6..a9cf105 100644 --- a/docs/index.md +++ b/docs/index.md @@ -1,11 +1,11 @@ -# Welcome to PawianTools! +# Welcome to Pawian Tools! ```{title} Welcome ``` [![GPLv3+ license](https://img.shields.io/badge/License-GPLv3+-blue.svg)](https://www.gnu.org/licenses/gpl-3.0-standalone.html) -[![Test coverage](https://codecov.io/gh/redeboer/PawianTools/branch/main/graph/badge.svg)](https://codecov.io/gh/redeboer/PawianTools) +[![Test coverage](https://codecov.io/gh/RUB-EP1/pawian-tools/branch/main/graph/badge.svg)](https://codecov.io/gh/RUB-EP1/pawian-tools) This repository serves as a collection of Python tools to complement [Pawian](https://panda-wiki.gsi.de/bin/view/PWA/PawianPwaSoftware). There are diff --git a/docs/install.md b/docs/install.md index 5047d0f..220f822 100644 --- a/docs/install.md +++ b/docs/install.md @@ -3,11 +3,11 @@ The fastest way of installing this package is through PyPI: ```shell -python3 -m pip install git+https://github.com/redeboer/PawianTools@main +python3 -m pip install git+https://github.com/RUB-EP1/pawian-tools@main ``` This installs the latest version that you can find on the -[`main`](https://github.com/redeboer/PawianTools/tree/main) branch. +[`main`](https://github.com/RUB-EP1/pawian-tools/tree/main) branch. However, we highly recommend using the more dynamic, {ref}`'editable installation' ` instead. This @@ -16,8 +16,8 @@ goes as follows: 1. Get the source code (see [the Pro Git Book](https://git-scm.com/book/en/v2)): ```shell - git clone https://github.com/redeboer/PawianTools.git - cd PawianTools + git clone https://github.com/RUB-EP1/pawian-tools + cd pawian-tools ``` 2. **[Recommended]** Create a virtual environment (see diff --git a/docs/usage/qa.ipynb b/docs/usage/qa.ipynb index 13c32c0..15d9291 100644 --- a/docs/usage/qa.ipynb +++ b/docs/usage/qa.ipynb @@ -14,7 +14,7 @@ "cell_type": "markdown", "metadata": {}, "source": [ - "This notebook shows how to to investigate the content of a `pawianHists.root` file that is the result of the QA step in Pawian. We make use of the {mod}`pawian.qa` module of PawianTools." + "This notebook shows how to to investigate the content of a `pawianHists.root` file that is the result of the QA step in Pawian. We make use of the {mod}`pawian.qa` module of Pawian Tools." ] }, { diff --git a/pyproject.toml b/pyproject.toml index ea0696f..1d994b8 100644 --- a/pyproject.toml +++ b/pyproject.toml @@ -102,10 +102,10 @@ content-type = "text/markdown" file = "README.md" [project.urls] -Changelog = "https://github.com/redeboer/PawianTools/releases" -Documentation = "http://redeboer.github.io/PawianTools" -Source = "https://github.com/redeboer/PawianTools" -Tracker = "https://github.com/redeboer/PawianTools/issues" +Changelog = "https://github.com/RUB-EP1/pawian-tools/releases" +Documentation = "http://rub-ep1.github.io/pawian-tools" +Source = "https://github.com/RUB-EP1/pawian-tools" +Tracker = "https://github.com/RUB-EP1/pawian-tools/issues" [tool.setuptools] include-package-data = false diff --git a/src/pawian/__init__.py b/src/pawian/__init__.py index 6f42b9d..271d81c 100644 --- a/src/pawian/__init__.py +++ b/src/pawian/__init__.py @@ -1,4 +1,4 @@ -"""The PawianTools package. +"""The Pawian Tools package. A collection of Python tools that facilitate working with `Pawian `__ output. Note that the diff --git a/src/pawian/data.py b/src/pawian/data.py index 7fda85b..deb1b04 100644 --- a/src/pawian/data.py +++ b/src/pawian/data.py @@ -1,4 +1,4 @@ -"""Data module of PawianTools. +"""Data module of Pawian Tools. This module allows you to parse and analyze ASCII data files of momentum tuples. The files have the following form: