AmpForm 0.8.0
Release 0.8.0
See all documentation for this version here.
💡 New features
Extend Blatt-Weisskopf to L <= 8 (#15)
- Improved rendering of the
BlattWeisskopf
in the API and the lineshape notebook - Extended the Blatt-Weisskopf definition to angular momentum of up to L <= 8
⚠️ Interface
Rename particle argument to resonance (#17)
First argument of the ResonanceDynamicsBuilder
protocol has been renamed to resonance
.
Improve BlattWeisskopf signature (#25)
Previously only had args
, now it has a specific signature.
📝 Documentation
Improve citation labels and bibliography (#14)
- Both DOI and URLs are now in the bibliography file. If both are available, only the DOI is rendered in the HTML pages (with link).
- References are now shown as [Author et al. year] instead of some number e.g. [1].
- Language tags have been removed from the
bibliography.bib
file. - Added more type hints to the
docs/conf.py
file
Improve instructions for custom dynamics (#16)
Made the custom dynamics instructions a bit more user-friendly by:
- putting the
import
statements where they are used (for copy-button) - clarifying what the output of a custom dynamics builder is by declaring an
expression
andparameter_defaults
parameter
🎉 Add notebook with interactive Argand plots (#23)
A new page has been added that illustrates how to use mpl-interactions to inspect the amplitude model. The page is a notebook that can be used interactively, but also renders nicely as an animation on the rendered HTML page itself.
Improve introductory text on main index page and usage page (#26)
🖱️ Developer Experience
Split CI workflow into sty, docs, and tests (#13)
Standardize cspell config (#18)
Use the new check-dev-files
hook to rename and format the .cspell.json
file.
Verify shape of amplitude model and increase test coverage (#20)
Previously, the tests did not check the shape of the complete amplitude model (specifically, the dynamics). The documentation only shows what those shapes look like, but don't check their shape. This is a problem when refactoring the dynamics (see in particular the epic/improve-dynamics branch).
Remove redundant dev dependencies (#22)
In particular pydeps
and ipywidgets
(which may be added later on again in the dynamics epic branch).