Qrules

_See all documentation for this version [here](https://qrules.rtfd.io/en/0.10.2)._

⚠️ API changes

- Drop support for Python 3.6 (250)
- URLs of the API page ([qrules.rtfd.io](https://qrules.readthedocs.io)) now end in `.html` again (#267)

⚠️ Enhancements and optimizations

- Postpone annotation evaluations (251)
- Specify allowed formalisms with `Literal` (253)
- Make `Parity.value` of type `Literal[-1, 1]` (263)
- Add `Path` to allowed `load()` arguments (264)
- Upgrade to `python-constraint2` (268)

🐛 Bug fixes

- Print top number in Gell-Mann-Nishijima error (262)

🔨 Maintenance

- Use absolute imports only (252)
- Remove `TypeAlias` (254)

🖱️ Developer Experience

- Configure project with `pyproject.toml` only and remove `setup.cfg` (250)
- Remove JSON schema for Read the Docs (259)

_The full changelog as commits can be found [here](https://github.com/ComPWA/qrules/compare/0.10.1...0.10.2)._

_See all documentation for this version [here](https://qrules.rtfd.io/en/0.10.1)._

⚠️ Enhancements and optimizations
- Warn on violated rules instead of raising exceptions (224)
- Remove topology edge number check (249)

🐛 Bug fixes
- Show only selected rules in DOT rendering (225)

📝 Documentation
- Switch to Ruff as linter (222)
- Illustrate use of `interaction_determinators` (226)
- Add `CITATION.cff` (228)
- Update links to compwa.github.io (244)
- Remove `.html` from page URLs (245)
- Switch to source code link button (246)

🔨 Maintenance
- Test QRules on Python 3.12 (235)

🖱️ Developer Experience
- Enable language navigation on Jupyter Lab (229)
- Remove `figure_formats = ["svg"]` statement (237)
- Install Ruff and Git in Jupyter Lab (238)
- Define `docnblive` job in `tox.ini` (240)
- Switch to Ruff formatter (248)

_The full changelog as commits can be found [here](https://github.com/ComPWA/qrules/compare/0.10.0...0.10.1)._

_See all documentation for this version [here](https://qrules.rtfd.io/en/0.10.0)._

⚠️ Interface

- The `StateTransitionCollection` class has been removed (155)
- `StateTransitionGraph` and related classes have been generalised to `MutableTransition` (156)

✨ New features

- Quantum number solutions can now be inspected separately (168)

⚠️ Enhancements and optimizations

- The `qrules.io._dot` module has been redesigned in an open-closed style to make it easier to extend (157)

🐛 Bug fixes

- Permutate topology edges, not property mappings (218)

_The full changelog as commits can be found [here](https://github.com/ComPWA/qrules/compare/0.9.8...0.10.0)._

_See all documentation for this version [here](https://qrules.rtfd.io/en/0.10.0a1)._

⚠️ Interface

- Removed [`StateTransitionCollection`](https://qrules.readthedocs.io/en/0.9.7/api/qrules.transition.html#qrules.transition.StateTransitionCollection) (155)
- Generalized [`StateTransitionGraph`](https://qrules.readthedocs.io/en/0.9.7/api/qrules.topology.html#qrules.topology.StateTransitionGraph) to a [`MutableTransition`](https://qrules.readthedocs.io/en/0.10.0a1/api/qrules.topology.html#qrules.topology.MutableTransition) class (156)

🐛 Bug fixes

- `execution_info` is now defined outside conditionals (162)

🔨 Internal maintenance

- [`io.asdot()`](https://qrules.readthedocs.io/en/0.10.0a1/api/qrules.io.html#qrules.io.asdot) function now has an open-closed design (157)

🖱️ Developer Experience

- Removed Sphinx HTML theme option `theme_dev_mode` (167)

_See all documentation for this version [here](https://qrules.rtfd.io/en/0.9.8)._

✨ New features

- Allow setting interactions per node (210)
- Select allowed resonances with regex (212)

⚠️ Enhancements and optimizations

- Finegrain logging levels (215)


🐛 Bug fixes

- Define execution_info outside conditionals (162)
- Improve documentation sidebar (209)
- Handle `None` parity in `parity_conservation` (211)
- Modify `isospin` in `create_particle()` (216)
- Add test for ψ(2S) → η K⁻ K*(892)⁺ (166)
- Permutate topology edges, not property mappings (217)

📝 Documentation

- Switch to `sphinx-design` (189)
- Update Zenodo author list (192)
- Improve documentation sidebar (209)

🔨 Maintenance

- Switch to black's default 88 line width (188)
- Verify installation on Python 3.11 (204)

🖱️ Developer Experience

- Remove theme option theme_dev_mode (167)
- Pin all dependencies on Read the Docs (172)
- Build documentation with make (178)
- Implement GitHub Actions caching (201)
- Outsource GitHub workflows to ComPWA/actions (205)
- Colorize `sphinx-build` output (208)

_The full changelog as commits can be found [here](https://github.com/ComPWA/qrules/compare/0.9.7...0.9.8)._

_See all documentation for this version [here](https://qrules.rtfd.io/en/0.9.7)._

🐛 Bug fixes

<details>
<summary>ReactionInfo is now hashable (151)</summary>

This is particularly useful for [`functools.lru_cache()`](https://docs.python.org/3/library/functools.html#functools.lru_cache).

</details>

🔨 Internal maintenance

<details>
<summary>Switched to the new attrs API (152)</summary>

See [`import attrs`](https://hynek.me/articles/import-attrs/#the-last-step-import-attrs) and [`attrs` TNG](https://www.attrs.org/en/21.4.0/names.html#attrs-tng).

</details>

<details>
<summary>implement_pretty_repr() decorator is now implement_pretty_repr (154)</summary>

The `implement_pretty_repr()` decorator does not take any arguments, so one level can be removed. This changes it's usage from:

python
implement_pretty_repr() old
attrs.define
class SomeClass:
...


to

python
implement_pretty_repr <-- new
attrs.define
class SomeClass:
...


</details>

📝 Documentation

<details>
<summary>Type hints are abbreviated where possible (154)</summary>

Type hints are abbreviated with [`autodoc_typehints_format`](https://www.sphinx-doc.org/en/master/usage/extensions/autodoc.html#confval-autodoc_typehints_format). But note that this does not yet work perfectly because of QRules' [custom reference relinking](https://github.com/ComPWA/qrules/commit/837923872c85e43b765ee7c5a3d6e415d8e330ad).

</details>

<details>
<summary>API is now sorted by position in the source code (154)</summary>

API is now sorted by position in the source code, **not alphabetically**.

</details>

<details>
<summary>Left sidebar is unfolded unto the second level (148)</summary>

Also unfolds the left sidebar unto the second level, like in https://github.com/ComPWA/ampform/pull/221 and https://github.com/ComPWA/tensorwaves/pull/407. Preview [here](https://qrules--148.org.readthedocs.build/en/148).

</details>

<details>
<summary>Added Hypothesis and utterances overlay to allow commenting on the documentation (149)</summary>

Closes https://github.com/ComPWA/compwa-org/issues/109

</details>

<details>
<summary>Explained how to pin dependencies with Conda (150)</summary>

Preview [here](https://qrules--150.org.readthedocs.build/en/150/install.html). See also https://github.com/ComPWA/tensorwaves/pull/411.

</details>

🖱️ Developer Experience

<details>
<summary>Upgrade cron job are now on even weeks only (148 and 153)</summary>

See https://github.com/ComPWA/repo-maintenance/pull/48

</details>