Tensorwaves

_See all documentation for this version [here](https://tensorwaves.rtfd.io/en/0.2.4)._
(Maintenance release: mainly improves mobile version of the website.)

⚠️ Interface

<details>
<summary>Optional dependency section "extras" has been renamed to "all" (6ff7ecc)</summary>

</details>

🔨 Internal maintenance

<details>
<summary>Switch to first (non pre-)release of qrules and ampform (265)</summary>

In addition, extract pytest configuration to `pytest.ini` and define `testpaths` there. Since b9b72ed, it is become impossible to run tests through VSCode. Defining testpaths fixes this. In addition, it removes the last 'non-tox' section from the tox.ini file (see 7eb3866)

</details>

🖱️ Developer Experience

<details>
<summary>Move dependency definitions back back to setup.cfg (264)</summary>

With the release of [`pip-tools` v6.1.0](https://github.com/jazzband/pip-tools/releases/tag/6.1.0), `pip-compile` now correctly handles [`extras_require`](https://setuptools.readthedocs.io/en/latest/userguide/dependency_management.html#optional-dependencies). This allows for a big clean-up of the set-up introduced by https://github.com/ComPWA/expertsystem/pull/412.

Advantages:

- Easier for the user and developer! Just run: `pip install -e .[dev]` to get started developing, `pip install -e .[dev] -U` to try out upgrades, and `pip install -c .constraints/py3.8.txt -e .[dev] -U` in case you exactly want to reproduce the dependencies for some commit.
- The upgrade jobs become significantly faster: [bit over 1min](https://github.com/ComPWA/qrules/runs/2346236017?check_suite_focus=true) versus almost [3min](https://github.com/ComPWA/qrules/runs/2322145112?check_suite_focus=true)
- All requirements, their version domains, and the dependencies between each of the requirement sections can be nicely overseen and maintained within `setup.cfg`
- Git diffs for pull requests that affect dependencies become easier to oversee
- Less complexity and fewer changes per commit

</details>

<details>
<summary>Add PR template + GitPod extensions (266)</summary>

</details>

<details>
<summary>Annotations in API are abbreviated if they are links (267)</summary>

Makes it easier to understand function signatures.

</details>

<details>
<summary>Doctests are now verified through pytest (b9b72ed)</summary>

</details>

<details>
<summary>Updated installation instructions (8f94021)</summary>

Added references to requirement pinning

</details>

<details>
<summary>Added more flake8 plugins and fixed identified issues (feefdfb)</summary>

Also cleans up the `.pylintrc` config file

</details>

<details>
<summary>Split all config files for dev tools (7eb3866)</summary>

Better to only keep tox job definitions in the tox.ini file. Note that config files are only extracted if their respective tools supports a config file name that starts with a dot

</details>

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

🔨 Internal maintenance

- The [`expertsystem`](https://expertsystem.rtfd.io) has been replaced by [`ampform`](https://ampform.rtfd.io) and [`qrules`](https://qrules.rtfd.io)
- The `master` branch has been [renamed to `main`](https://github.blog/changelog/2020-10-01-the-default-branch-for-newly-created-repositories-is-now-main).

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

💡 New features

<details>
<summary>Added the option to cache constant sub-expressions in SympyModels (247 and 260)</summary>

Closes 100

</details>


⚠️ Interface

<details>
<summary>Optimize result is returned as a FitResult class (254)</summary>

Wrapped the optimize `dict` output in a `FitResult` class. It's a rather simple `attr` data container that wraps what was previously in a `dict` form. Optimizer-specific info has been put under a `specifics` attribute.

</details>


🐛 Bug fixes

<details>
<summary>YAMLSummary callback correctly handles complex values (252)</summary>
</details>

<details>
<summary>YAMLSummary now also dumps the final fit result at on_optimize_end, not only for each optimize step (252)</summary>
</details>

<details>
<summary>Complex parameter values are now correctly loaded from CSV (253)</summary>

The `csv.DictReader` crashes when there are complex values (and using `QUOTE_NONNUMERIC`). This was not spotted, because the tests only work with float parameters. Now one additional (complex) parameter is set free and the bug has been fixed. To speed up the tests, the UnbinnedNLL fixture uses Jax now.

</details>


🔨 Internal maintenance

<details>
<summary>Upgraded to expertsystem v0.7.1-2, which renders StateTransitionGraphs more nicely (259)</summary>


</details>


📝 Documentation

<details>
<summary>Added install cells in Jupyter notebooks for Google Colab (250 and 251)</summary>

See https://github.com/ComPWA/expertsystem/pull/535

</details>


🖱️ Developer Experience

<details>
<summary>Added cspell, pyright, and ComPWA/meta pre-commit hooks (256)</summary>

- No need to install [Pyright](https://github.com/microsoft/pyright) and [cSpell](https://github.com/streetsidesoftware/cspell/tree/master/packages/cspell) anymore (through `npm`), because they are now executed as a `pre-commit` hook. See [ComPWA/mirrors-cspell](https://github.com/ComPWA/mirrors-cspell) and [ComPWA/mirrors-pyright](https://github.com/ComPWA/mirrors-pyright).
- Replaced scripts under `.pre-commit-hooks` with hooks from the [ComPWA/meta](https://github.com/ComPWA/meta) repository. Now the `tox -e sty` job works again.

</details>

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

💡 New features

- Added `ScipyMinimizer` adapter as an interface to [`scipy.optimize.minimize`](https://docs.scipy.org/doc/scipy/reference/generated/scipy.optimize.minimize.html) (#231, 235, and 241)
- Added more initialize stage and end stages to the `Callback` interface (234)
- New façade functions in the `physics` module help extracting intensity components from the amplitude model (244)
- Added support for lambdifying to `tensorflow` (245)
(The resulting function is not efficient yet. This may have to wait until TF v2.5 is out or other improvements to the lambdifying are implemented, like 100.)

⚠️ Interface

- New abstracts for the `Callback` interface: `.on_optimize_start()` and `.on_optimize_end()` (234)
- There's a new top module: `physics` (244)

🔨 Internal maintenance

- No dependency on `pandas` anymore: the `CSVSummary` callback uses `csv.DictWriter` instead (239)
- Upgraded to [`expertsystem` v0.7.1](https://github.com/ComPWA/expertsystem/releases/tag/0.7.1) (#248)

📝 Documentation

- New example notebook: generate data and optimize for an arbitrary model (232)
- Added a SciPy example fit to usage notebook (235)
- Improved the optimize process plots (242)
- Figures are now rendered as SVG (243)

🖱️ Developer Experience

- Added [`collapsible_headings`](https://github.com/aquirdTurtle/Collapsible_Headings) for Jupyter Lab (#233)
- Packages listed under `extras_require` are now also pinned through the developer dependencies (240)

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

⚠️ Interface

**Several breaking changes!**
All physics (`amplitude`, `dynamics`, and `kinematics` modules) has been moved to the `expertsystem`, where the amplitude model is now formulated in terms of SymPy (see [v0.7.0](https://github.com/ComPWA/expertsystem/releases/tag/0.7.0)). TensorWaves is now more abstract: the core has become a template `Model` class that can be 'lambdified' into a `Function` with different computational backends. The `esimator` and `data` modules are still there, but changed slightly because of the intermediate `Model` layer.

Since the responsibilities of `tensorwaves` have changed quite a bit and much code has been removed, the module structure has been changed drastically as well. The example workflow notebooks therefore changed as well.

_The new workflow is described [here](https://pwa.readthedocs.io/projects/tensorwaves/en/stable/usage.html)._

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

**This is the final release before the switch to SymPy.** See 222 and `expertsystem` [v0.7.0a0](https://github.com/ComPWA/expertsystem/releases/tag/0.7.0a0).

🐛 Bug fixes

- Progress bar works better now in Jupyter notebook because of `tqdm.autonotebook` (223)

🔨 Internal maintenance
- Upgraded to `expertsystem` [v0.6.10](https://pwa.readthedocs.io/projects/expertsystem/en/0.6.10) (#224)
- Upgraded to [`iminuit` v2.x](https://iminuit.readthedocs.io/en/stable/changelog.html#december-7-2020) (213)

📝 Documentation

- Visualization of modules with `pydeps` has been removed (202)
- Top of each sub-module API page has an `import` statement so that it is easier to see where the sub-module is located (217)

🖱️ Developer Experience

_See also [changes listed in `expertsystem` v0.6.10](https://github.com/ComPWA/expertsystem/releases/tag/0.6.10)_
- Certain GitHub Actions can now be started manually (208)
- CI runs on draft PR again (210)
- Preference is now given over intersphinx syntax links (215)
- Added infrastructure for generating custom stubs to the `typing` folder (216)
- `pre-commit` hooks are now automatically upgraded through GitHub Actions(220)
- Notebooks can now be run and rendered as HTML through `tox -e doclive` as well (225)