phasespace 1.10.4__tar.gz → 2.0.0__tar.gz

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (85) hide show
  1. phasespace-2.0.0/.github/dependabot.yml +16 -0
  2. {phasespace-1.10.4 → phasespace-2.0.0}/.github/workflows/cd.yml +8 -8
  3. phasespace-2.0.0/.github/workflows/ci.yml +203 -0
  4. {phasespace-1.10.4 → phasespace-2.0.0}/.gitignore +8 -0
  5. {phasespace-1.10.4 → phasespace-2.0.0}/.pre-commit-config.yaml +9 -29
  6. phasespace-2.0.0/.readthedocs.yml +22 -0
  7. phasespace-2.0.0/CHANGELOG.md +213 -0
  8. phasespace-2.0.0/CITATION.cff +29 -0
  9. phasespace-2.0.0/CONTRIBUTING.md +123 -0
  10. phasespace-2.0.0/MANIFEST.in +13 -0
  11. phasespace-2.0.0/PKG-INFO +244 -0
  12. phasespace-2.0.0/README.md +191 -0
  13. {phasespace-1.10.4 → phasespace-2.0.0}/benchmark/bench_phasespace.py +1 -11
  14. {phasespace-1.10.4 → phasespace-2.0.0}/benchmark/monitoring.py +0 -9
  15. phasespace-2.0.0/codecov.yml +1 -0
  16. phasespace-2.0.0/docs/conf.py +115 -0
  17. phasespace-2.0.0/docs/contributing.md +2 -0
  18. phasespace-1.10.4/docs/GenMultiDecay_Tutorial.ipynb → phasespace-2.0.0/docs/fromdecay.ipynb +35 -26
  19. phasespace-2.0.0/docs/history.md +2 -0
  20. phasespace-2.0.0/docs/index.md +13 -0
  21. phasespace-1.10.4/docs/phasespace.rst → phasespace-2.0.0/docs/phasespace.md +22 -8
  22. phasespace-2.0.0/docs/usage.md +205 -0
  23. {phasespace-1.10.4 → phasespace-2.0.0}/pyproject.toml +29 -34
  24. phasespace-2.0.0/src/phasespace/__init__.py +21 -0
  25. {phasespace-1.10.4 → phasespace-2.0.0}/src/phasespace/_version.py +2 -2
  26. phasespace-2.0.0/src/phasespace/backend/__init__.py +241 -0
  27. phasespace-2.0.0/src/phasespace/backend/_jax.py +62 -0
  28. phasespace-2.0.0/src/phasespace/backend/_numpy.py +43 -0
  29. phasespace-2.0.0/src/phasespace/backend/_tensorflow.py +32 -0
  30. phasespace-2.0.0/src/phasespace/backend/_types.py +29 -0
  31. {phasespace-1.10.4 → phasespace-2.0.0}/src/phasespace/fromdecay/__init__.py +4 -6
  32. {phasespace-1.10.4 → phasespace-2.0.0}/src/phasespace/fromdecay/genmultidecay.py +21 -15
  33. {phasespace-1.10.4 → phasespace-2.0.0}/src/phasespace/kinematics.py +16 -27
  34. {phasespace-1.10.4 → phasespace-2.0.0}/src/phasespace/phasespace.py +164 -164
  35. phasespace-2.0.0/src/phasespace/random.py +36 -0
  36. phasespace-2.0.0/tests/conftest.py +18 -0
  37. phasespace-2.0.0/tests/fromdecay/conftest.py +10 -0
  38. {phasespace-1.10.4 → phasespace-2.0.0}/tests/fromdecay/test_fromdecay.py +1 -2
  39. {phasespace-1.10.4 → phasespace-2.0.0}/tests/fromdecay/test_mass_functions.py +2 -3
  40. phasespace-2.0.0/tests/helpers/__init__.py +14 -0
  41. {phasespace-1.10.4 → phasespace-2.0.0}/tests/helpers/decays.py +15 -21
  42. {phasespace-1.10.4 → phasespace-2.0.0}/tests/helpers/plotting.py +0 -9
  43. {phasespace-1.10.4 → phasespace-2.0.0}/tests/helpers/rapidsim.py +0 -9
  44. phasespace-2.0.0/tests/test_backends.py +326 -0
  45. {phasespace-1.10.4 → phasespace-2.0.0}/tests/test_chain.py +50 -22
  46. {phasespace-1.10.4 → phasespace-2.0.0}/tests/test_generate.py +19 -15
  47. {phasespace-1.10.4 → phasespace-2.0.0}/tests/test_nbody_decay.py +1 -9
  48. {phasespace-1.10.4 → phasespace-2.0.0}/tests/test_physics.py +63 -48
  49. {phasespace-1.10.4 → phasespace-2.0.0}/tests/test_random.py +17 -7
  50. phasespace-2.0.0/tests/test_regressions.py +59 -0
  51. phasespace-1.10.4/.github/dependabot.yml +0 -7
  52. phasespace-1.10.4/.github/workflows/ci.yml +0 -141
  53. phasespace-1.10.4/.readthedocs.yml +0 -21
  54. phasespace-1.10.4/AUTHORS.rst +0 -20
  55. phasespace-1.10.4/CHANGELOG.rst +0 -208
  56. phasespace-1.10.4/CITATION.cff +0 -21
  57. phasespace-1.10.4/CONTRIBUTING.rst +0 -125
  58. phasespace-1.10.4/MANIFEST.in +0 -14
  59. phasespace-1.10.4/PKG-INFO +0 -342
  60. phasespace-1.10.4/README.rst +0 -230
  61. phasespace-1.10.4/docs/authors.rst +0 -1
  62. phasespace-1.10.4/docs/conf.py +0 -262
  63. phasespace-1.10.4/docs/contributing.rst +0 -1
  64. phasespace-1.10.4/docs/history.rst +0 -1
  65. phasespace-1.10.4/docs/index.rst +0 -18
  66. phasespace-1.10.4/docs/usage.rst +0 -213
  67. phasespace-1.10.4/src/phasespace/__init__.py +0 -33
  68. phasespace-1.10.4/src/phasespace/backend.py +0 -23
  69. phasespace-1.10.4/src/phasespace/random.py +0 -40
  70. phasespace-1.10.4/tests/conftest.py +0 -4
  71. phasespace-1.10.4/tests/helpers/__init__.py +0 -0
  72. {phasespace-1.10.4 → phasespace-2.0.0}/.git_archival.txt +0 -0
  73. {phasespace-1.10.4 → phasespace-2.0.0}/.gitattributes +0 -0
  74. {phasespace-1.10.4 → phasespace-2.0.0}/LICENSE +0 -0
  75. {phasespace-1.10.4 → phasespace-2.0.0}/benchmark/bench_tgenphasespace.cxx +0 -0
  76. {phasespace-1.10.4 → phasespace-2.0.0}/docs/Makefile +0 -0
  77. {phasespace-1.10.4 → phasespace-2.0.0}/docs/make.bat +0 -0
  78. {phasespace-1.10.4 → phasespace-2.0.0}/paper/paper.bib +0 -0
  79. {phasespace-1.10.4 → phasespace-2.0.0}/paper/paper.md +0 -0
  80. {phasespace-1.10.4 → phasespace-2.0.0}/scripts/prepare_test_samples.cxx +0 -0
  81. {phasespace-1.10.4 → phasespace-2.0.0}/src/phasespace/fromdecay/mass_functions.py +0 -0
  82. {phasespace-1.10.4 → phasespace-2.0.0}/tests/__init__.py +0 -0
  83. {phasespace-1.10.4 → phasespace-2.0.0}/tests/fromdecay/__init__.py +0 -0
  84. {phasespace-1.10.4 → phasespace-2.0.0}/tests/fromdecay/example_decay_chains.py +0 -0
  85. {phasespace-1.10.4 → phasespace-2.0.0}/tests/fromdecay/example_decays.dec +0 -0
@@ -0,0 +1,16 @@
1
+ version: 2
2
+
3
+ multi-ecosystem-groups:
4
+ lock:
5
+ commit-message: { prefix: "build(deps)" }
6
+ schedule: { interval: quarterly }
7
+
8
+ updates:
9
+ - package-ecosystem: github-actions
10
+ directory: "/"
11
+ multi-ecosystem-group: lock
12
+ patterns: ["*"]
13
+ - package-ecosystem: pre-commit
14
+ directory: "/"
15
+ multi-ecosystem-group: lock
16
+ patterns: ["*"]
@@ -11,13 +11,13 @@ on:
11
11
 
12
12
  jobs:
13
13
  dist:
14
- runs-on: ubuntu-latest
14
+ runs-on: ubuntu-26.04
15
15
 
16
16
  steps:
17
- - uses: actions/checkout@v6
17
+ - uses: actions/checkout@3d3c42e5aac5ba805825da76410c181273ba90b1 # v7.0.1
18
18
  with:
19
19
  fetch-depth: 0
20
- - uses: actions/setup-python@v6
20
+ - uses: actions/setup-python@6d4fd22b20465ccc0f7354476588e8df7c9ca0e0 # v7.1.0
21
21
 
22
22
  - name: Build SDist and wheel
23
23
  run: pipx run --spec build pyproject-build
@@ -25,20 +25,20 @@ jobs:
25
25
  - name: Check metadata
26
26
  run: pipx run twine check dist/*
27
27
 
28
- - uses: actions/upload-artifact@v7
28
+ - uses: actions/upload-artifact@cf430e030ddbb5b0abf93d22962f4752f3646cd9 # v7.0.2
29
29
  with:
30
30
  path: dist/*
31
31
  publish:
32
- needs: [ dist ]
32
+ needs: [dist]
33
33
  environment: pypi
34
34
  permissions:
35
35
  id-token: write
36
- runs-on: ubuntu-latest
36
+ runs-on: ubuntu-26.04
37
37
  if: github.event_name == 'release' && github.event.action == 'published'
38
38
  steps:
39
- - uses: actions/download-artifact@v8
39
+ - uses: actions/download-artifact@9000827ccba6bdab643e8b6fd33ac0654aef8333 # v8.0.2
40
40
  with:
41
41
  name: artifact
42
42
  path: dist
43
43
 
44
- - uses: pypa/gh-action-pypi-publish@release/v1
44
+ - uses: pypa/gh-action-pypi-publish@7245906fb61fa33a13554f9d5fb856fe61758086 # v1.14.3
@@ -0,0 +1,203 @@
1
+ # This workflow will install Python dependencies, run tests and lint with a variety of Python versions
2
+ # For more information see: https://help.github.com/actions/language-and-framework-guides/using-python-with-github-actions
3
+
4
+ name: tests
5
+
6
+ concurrency:
7
+ group: ${{ github.ref }}
8
+ cancel-in-progress: true
9
+
10
+ on:
11
+ workflow_dispatch:
12
+ push:
13
+ tags:
14
+ - "*"
15
+ branches:
16
+ - main
17
+ - develop
18
+ - "release/*"
19
+ - "hotfix/*"
20
+ pull_request:
21
+ branches-ignore:
22
+ - "docs/*"
23
+ - "doc/*"
24
+
25
+ jobs:
26
+ download-data:
27
+ runs-on: ubuntu-26.04
28
+ steps:
29
+ - uses: actions/checkout@3d3c42e5aac5ba805825da76410c181273ba90b1 # v7.0.1
30
+ - name: Cache test data
31
+ id: cache-data
32
+ uses: actions/cache@55cc8345863c7cc4c66a329aec7e433d2d1c52a9 # v6.1.0
33
+ with:
34
+ path: data/large
35
+ key: test-data-${{ hashFiles('data/download_test_files.py') }}
36
+ - name: Set up Python
37
+ if: steps.cache-data.outputs.cache-hit != 'true'
38
+ uses: actions/setup-python@6d4fd22b20465ccc0f7354476588e8df7c9ca0e0 # v7.1.0
39
+ with:
40
+ python-version: "3.10"
41
+ - name: Install wget
42
+ if: steps.cache-data.outputs.cache-hit != 'true'
43
+ run: pip install wget
44
+ - name: Download test data
45
+ if: steps.cache-data.outputs.cache-hit != 'true'
46
+ run: PHASESPACE_SILENT=1 python data/download_test_files.py
47
+ - name: Upload test data artifact
48
+ uses: actions/upload-artifact@cf430e030ddbb5b0abf93d22962f4752f3646cd9 # v7.0.2
49
+ with:
50
+ name: test-data
51
+ path: data/large
52
+ retention-days: 1
53
+
54
+ codecov:
55
+ needs: download-data
56
+ permissions:
57
+ contents: read
58
+ id-token: write
59
+ runs-on: ubuntu-26.04
60
+ strategy:
61
+ fail-fast: false
62
+ matrix:
63
+ python-version: ["3.10"]
64
+ steps:
65
+ - uses: actions/checkout@3d3c42e5aac5ba805825da76410c181273ba90b1 # v7.0.1
66
+ - name: Download test data
67
+ uses: actions/download-artifact@9000827ccba6bdab643e8b6fd33ac0654aef8333 # v8.0.2
68
+ with:
69
+ name: test-data
70
+ path: data/large
71
+ - name: Set up Python ${{ matrix.python-version }}
72
+ uses: actions/setup-python@6d4fd22b20465ccc0f7354476588e8df7c9ca0e0 # v7.1.0
73
+ with:
74
+ python-version: ${{ matrix.python-version }}
75
+ - name: Install uv
76
+ uses: astral-sh/setup-uv@68559e99cc807c1eb7e9238fd43a15bba460eec2 # v10.3.3
77
+ with:
78
+ enable-cache: true
79
+ - name: Install dependencies
80
+ run: |
81
+ sudo apt install graphviz -y
82
+ uv pip install -e .[all] --group test --system
83
+ - name: Run pytest-cov
84
+ run: PYTHONPATH=src coverage run -m pytest tests
85
+ - name: Create XML report
86
+ run: coverage xml
87
+ - uses: codecov/codecov-action@303a32d7a59b442fa8d48b6a1cc6825c09c847a5 # v7.1.1
88
+ with:
89
+ files: ./coverage.xml
90
+ use_oidc: true
91
+
92
+ pytest:
93
+ needs: download-data
94
+ runs-on: ${{ matrix.os }}
95
+ name: >-
96
+ tests ${{ matrix.os }}, ${{ matrix.python-version }}, ${{ matrix.backend }}${{ matrix.eager == 1 && ' (eager)' || '' }}
97
+ strategy:
98
+ fail-fast: false
99
+ matrix:
100
+ include:
101
+ - os: ubuntu-26.04
102
+ python-version: "3.10"
103
+ backend: tensorflow
104
+ extras: all
105
+ eager: 0
106
+ - os: ubuntu-26.04
107
+ python-version: "3.10"
108
+ backend: tensorflow
109
+ extras: all
110
+ eager: 1
111
+ - os: ubuntu-26.04
112
+ python-version: "3.10"
113
+ backend: numpy
114
+ extras: vector
115
+ - os: ubuntu-26.04
116
+ python-version: "3.10"
117
+ backend: jax
118
+ extras: jax,vector
119
+ - os: ubuntu-26.04
120
+ python-version: "3.13"
121
+ backend: tensorflow
122
+ extras: all
123
+ eager: 0
124
+ - os: ubuntu-26.04
125
+ python-version: "3.13"
126
+ backend: tensorflow
127
+ extras: all
128
+ eager: 1
129
+ - os: ubuntu-26.04
130
+ python-version: "3.13"
131
+ backend: numpy
132
+ extras: vector
133
+ - os: ubuntu-26.04
134
+ python-version: "3.13"
135
+ backend: jax
136
+ extras: jax,vector
137
+ - os: ubuntu-26.04
138
+ python-version: "3.15"
139
+ backend: numpy
140
+ extras: vector
141
+ - os: ubuntu-26.04
142
+ python-version: "3.15"
143
+ backend: jax
144
+ extras: jax,vector
145
+ - os: macos-26
146
+ python-version: "3.13"
147
+ backend: tensorflow
148
+ extras: all
149
+ eager: 0
150
+ - os: macos-26
151
+ python-version: "3.13"
152
+ backend: numpy
153
+ extras: vector
154
+ - os: macos-26
155
+ python-version: "3.13"
156
+ backend: jax
157
+ extras: jax,vector
158
+ - os: windows-latest
159
+ python-version: "3.13"
160
+ backend: tensorflow
161
+ extras: all
162
+ eager: 0
163
+ - os: windows-latest
164
+ python-version: "3.13"
165
+ backend: numpy
166
+ extras: vector
167
+ - os: windows-latest
168
+ python-version: "3.13"
169
+ backend: jax
170
+ extras: jax,vector
171
+ steps:
172
+ - uses: actions/checkout@3d3c42e5aac5ba805825da76410c181273ba90b1 # v7.0.1
173
+ - name: Download test data
174
+ uses: actions/download-artifact@9000827ccba6bdab643e8b6fd33ac0654aef8333 # v8.0.2
175
+ with:
176
+ name: test-data
177
+ path: data/large
178
+ - name: Set up Python ${{ matrix.python-version }}
179
+ uses: actions/setup-python@6d4fd22b20465ccc0f7354476588e8df7c9ca0e0 # v7.1.0
180
+ with:
181
+ python-version: ${{ matrix.python-version }}
182
+ - name: Install uv
183
+ uses: astral-sh/setup-uv@68559e99cc807c1eb7e9238fd43a15bba460eec2 # v10.3.3
184
+ with:
185
+ enable-cache: true
186
+ - name: Install graphviz (Ubuntu)
187
+ if: runner.os == 'Linux'
188
+ run: sudo apt install graphviz -y
189
+ - name: Install graphviz (macOS)
190
+ if: runner.os == 'macOS'
191
+ run: brew install graphviz
192
+ - name: Install graphviz (Windows)
193
+ if: runner.os == 'Windows'
194
+ run: choco install graphviz -y
195
+ - name: Install dependencies
196
+ run: uv pip install -e '.[${{ matrix.extras }}]' --group test --system
197
+ shell: bash
198
+ - name: Test with pytest
199
+ env:
200
+ PHASESPACE_BACKEND: ${{ matrix.backend }}
201
+ PHASESPACE_EAGER: ${{ matrix.eager || 0 }}
202
+ run: pytest -n auto tests
203
+ shell: bash
@@ -82,11 +82,13 @@ celerybeat-schedule
82
82
 
83
83
  # dotenv
84
84
  .env
85
+ .envrc
85
86
 
86
87
  # virtualenv
87
88
  .venv
88
89
  venv/
89
90
  ENV/
91
+ uv.lock
90
92
 
91
93
  # Spyder project settings
92
94
  .spyderproject
@@ -111,5 +113,11 @@ tests/plots
111
113
  /data/backup/B2KstGamma_RapidSim_7TeV_KstarNonResonant_Tree.root
112
114
  /data/backup/B2KstGamma_RapidSim_7TeV_Tree.root
113
115
  /src/phasespace/_version.py
116
+ .agents/
117
+ .claude/
118
+ /.editorconfig
114
119
  /.idea
120
+ .vscode/
121
+ AGENTS.md
122
+ CLAUDE.md
115
123
  /data
@@ -16,7 +16,6 @@ repos:
16
16
  - id: check-yaml
17
17
  - id: check-toml
18
18
  - id: debug-statements
19
- # - id: end-of-file-fixer # conflicts with jupyter notebook cleanup
20
19
  - id: mixed-line-ending
21
20
  - id: trailing-whitespace
22
21
  - id: detect-private-key
@@ -24,7 +23,7 @@ repos:
24
23
  - id: check-ast
25
24
 
26
25
  - repo: https://github.com/PyCQA/docformatter
27
- rev: v1.7.7
26
+ rev: v1.7.8
28
27
  hooks:
29
28
  - id: docformatter
30
29
  args:
@@ -34,58 +33,39 @@ repos:
34
33
  - --wrap-summaries=110
35
34
 
36
35
  - repo: https://github.com/pre-commit/pygrep-hooks
37
- rev: v1.10.0 # Use the ref you want to point at
36
+ rev: v1.10.0
38
37
  hooks:
39
38
  - id: python-use-type-annotations
40
39
  - id: python-check-mock-methods
41
40
  - id: python-no-eval
42
- - id: rst-directive-colons
43
-
44
- - repo: https://github.com/PyCQA/isort
45
- rev: 8.0.1
46
- hooks:
47
- - id: isort
48
41
 
49
42
  - repo: https://github.com/asottile/pyupgrade
50
- rev: v3.21.2
43
+ rev: v3.22.0
51
44
  hooks:
52
45
  - id: pyupgrade
53
- args: [ --py310-plus ]
46
+ args: [--py310-plus]
54
47
 
55
48
  - repo: https://github.com/mgedmin/check-manifest
56
49
  rev: "0.51"
57
50
  hooks:
58
51
  - id: check-manifest
59
- stages: [ manual ]
60
-
61
- - repo: https://github.com/sondrelg/pep585-upgrade
62
- rev: "v1.0" # Use the sha / tag you want to point at
63
- hooks:
64
- - id: upgrade-type-hints
65
- args: [ "--futures=true" ]
52
+ stages: [manual]
66
53
 
67
54
  - repo: https://github.com/MarcoGorelli/auto-walrus
68
55
  rev: 0.4.1
69
56
  hooks:
70
57
  - id: auto-walrus
71
58
 
72
-
73
- # - repo: https://github.com/pre-commit/mirrors-prettier
74
- # rev: "v4.0.0-alpha.8"
75
- # hooks:
76
- # - id: prettier
77
-
78
59
  - repo: https://github.com/kynan/nbstripout
79
60
  rev: 0.9.1
80
61
  hooks:
81
62
  - id: nbstripout
82
63
 
83
64
  - repo: https://github.com/astral-sh/ruff-pre-commit
84
- rev: "v0.15.9"
65
+ rev: v0.17.3
85
66
  hooks:
86
67
  - id: ruff
87
- types_or: [ python, pyi, jupyter ]
88
- args: [ --fix, --unsafe-fixes, --show-fixes , --line-length=120 ]
89
- # Run the formatter.
68
+ types_or: [python, pyi, jupyter]
69
+ args: [--fix, --unsafe-fixes, --show-fixes, --line-length=120]
90
70
  - id: ruff-format
91
- types_or: [ python, pyi, jupyter ]
71
+ types_or: [python, pyi, jupyter]
@@ -0,0 +1,22 @@
1
+ version: 2
2
+
3
+ build:
4
+ os: ubuntu-26.04
5
+ tools:
6
+ python: "3.13"
7
+ apt_packages:
8
+ - graphviz
9
+
10
+ python:
11
+ install:
12
+ - method: uv
13
+ command: sync
14
+ extras:
15
+ - fromdecay
16
+ - vector
17
+ groups:
18
+ - doc
19
+
20
+ sphinx:
21
+ configuration: docs/conf.py
22
+ fail_on_warning: true
@@ -0,0 +1,213 @@
1
+ # Changelog
2
+
3
+ ## [2.0.0](https://github.com/zfit/phasespace/releases/tag/2.0.0) (17 Nov 2026)
4
+
5
+ ### Behavioral changes
6
+
7
+ - NumPy is now the default backend. Select TensorFlow in Python with
8
+
9
+ ```python
10
+ import phasespace
11
+
12
+ phasespace.set_backend("tensorflow")
13
+ ```
14
+
15
+ or through the environment with
16
+
17
+ ```shell
18
+ export PHASESPACE_BACKEND=tensorflow
19
+ ```
20
+
21
+ ### Requirement changes
22
+
23
+ - NumPy is the only required dependency. TensorFlow and TensorFlow Probability move to the `tf` extra, which the `fromdecay` extra includes. Install it to keep using the TensorFlow backend:
24
+
25
+ ```shell
26
+ pip install "phasespace[tf]"
27
+ ```
28
+
29
+ - Python 3.14 and 3.15 are supported with the NumPy and JAX backends. The TensorFlow backend and the `fromdecay` extra remain limited to the Python versions that TensorFlow supports.
30
+
31
+ ## [1.11.0](https://github.com/zfit/phasespace/releases/tag/1.11.0) (15 Nov 2026)
32
+
33
+ ### Major features and improvements
34
+
35
+ - NumPy and optional JAX backends are available alongside TensorFlow, with runtime backend selection through `phasespace.set_backend` and `phasespace.get_backend`. Existing decay objects can be reused after switching. TensorFlow remains the default backend in this release.
36
+
37
+ ### Bug fixes and small changes
38
+
39
+ - Seeded resonance mass functions receive the generation random stream, zero Lorentz boosts no longer divide by zero, and NumPy mass checks accept equality.
40
+ - `GenMultiDecay` now has a readable representation that lists its decay modes and their probabilities.
41
+
42
+ ### Requirement changes
43
+
44
+ - The `fromdecay` extra now requires `particle>=0.25.0` and `decaylanguage>=0.19.0`.
45
+ - Developer dependencies are now defined as dependency groups (`test`, `doc`, `dev`) instead of the `test`, `doc` and `dev` extras. Install them with `pip install -e .[all] --group dev` (pip 25.1 or newer) or `uv sync --extra all`.
46
+
47
+ ### Documentation
48
+
49
+ - The documentation is now written in MyST Markdown and executed with MyST-NB. Read the Docs builds it with uv and creates previews for pull requests.
50
+
51
+ ## [1.10.4](https://github.com/zfit/phasespace/releases/tag/1.10.4) (16 Apr 2026)
52
+
53
+ ### Requirement changes
54
+
55
+ - Python 3.10 to 3.13 are supported. Support for Python 3.9 is dropped.
56
+ - TensorFlow 2.19 or newer and TensorFlow Probability 0.25 or newer are required.
57
+
58
+ ### Documentation
59
+
60
+ - The documentation uses the PyData Sphinx theme, which fixes its layout.
61
+
62
+ ## [1.10.3](https://github.com/zfit/phasespace/releases/tag/1.10.3) (23 Apr 2024)
63
+
64
+ ### Bug fixes and small changes
65
+
66
+ - `vector` was imported unconditionally and was therefore a required dependency. It is optional again and available through the `vector` extra.
67
+
68
+ ## [1.10.2](https://github.com/zfit/phasespace/releases/tag/1.10.2) (16 Apr 2024)
69
+
70
+ Technical release that fixes the build and deployment. No changes to the package.
71
+
72
+ ## [1.10.1](https://github.com/zfit/phasespace/releases/tag/1.10.1) (16 Apr 2024)
73
+
74
+ Technical release that fixes the deployment. No changes to the package.
75
+
76
+ ## 1.10.0 (16 Apr 2024)
77
+
78
+ ### Major features and improvements
79
+
80
+ - [vector](https://vector.readthedocs.io/en/latest/index.html) is supported in `generate`: `boost_to` can be a Momentum Lorentz vector, and `as_vectors=True` returns the boosted particles as vectors.
81
+
82
+ ### Requirement changes
83
+
84
+ - Python 3.12 is supported. Support for Python 3.8 is dropped.
85
+ - TensorFlow 2.16 or newer is required.
86
+
87
+ ## [1.9.0](https://github.com/zfit/phasespace/releases/tag/1.9.0) (20 Jul 2023)
88
+
89
+ ### Requirement changes
90
+
91
+ - Python 3.11 is supported. Support for Python 3.7 is dropped.
92
+
93
+ ## [1.8.0](https://github.com/zfit/phasespace/releases/tag/1.8.0) (27 Jan 2023)
94
+
95
+ ### Requirement changes
96
+
97
+ - zfit 0.10.0 or newer and zfit-physics 0.3.0 or newer are required.
98
+ - uproot and awkward are pinned to ~4 and ~1, respectively.
99
+
100
+ ## [1.7.0](https://github.com/zfit/phasespace/releases/tag/1.7.0) (1 Sep 2022)
101
+
102
+ The `tf` and `tensorflow` extras are added to the requirements. If you intend to use phasespace with TensorFlow in the future (and not only NumPy), always install with `phasespace[tf]`.
103
+
104
+ ### Requirement changes
105
+
106
+ - TensorFlow 2.7 or newer is required.
107
+ - Python 3.7 to 3.10 are supported.
108
+
109
+ ## [1.6.0](https://github.com/zfit/phasespace/releases/tag/1.6.0) (14 Apr 2022)
110
+
111
+ ### Major features and improvements
112
+
113
+ - `GenMultiDecay` gives better control over the decay mass of non-stable particles.
114
+ - `GenMultiDecay` has a new `particle_model_map` argument. This is a dict where the key is a particle name and the value is a mass function name. The feature is shown in the [GenMultiDecay Tutorial](https://phasespace.readthedocs.io/en/stable/fromdecay.html).
115
+
116
+ ## [1.5.0](https://github.com/zfit/phasespace/releases/tag/1.5.0) (27 Nov 2021)
117
+
118
+ ### Major features and improvements
119
+
120
+ - Decays can be generated from a DecayChain of the [decaylanguage](https://github.com/scikit-hep/decaylanguage) package from Scikit-HEP. This is in the new subpackage "fromdecay" and can be used by installing the extra with `pip install phasespace[fromdecay]`.
121
+
122
+ ### Requirement changes
123
+
124
+ - Support for Python 3.6 is dropped.
125
+
126
+ ### Thanks
127
+
128
+ - To Simon Thor for contributing the `fromdecay` subpackage.
129
+
130
+ ## [1.4.2](https://github.com/zfit/phasespace/releases/tag/1.4.2) (5 Nov 2021)
131
+
132
+ ### Requirement changes
133
+
134
+ - The restriction on TensorFlow is loosened to allow version 2.7 (and 2.5, 2.6).
135
+
136
+ ## [1.4.1](https://github.com/zfit/phasespace/releases/tag/1.4.1) (27 Aug 2021)
137
+
138
+ ### Requirement changes
139
+
140
+ - The restriction on TensorFlow is loosened to allow version 2.6 (and 2.5).
141
+
142
+ ## [1.4.0](https://github.com/zfit/phasespace/releases/tag/1.4.0) (11 Jun 2021)
143
+
144
+ ### Requirement changes
145
+
146
+ - TensorFlow 2.5 is required, as 2.4 breaks some functionality.
147
+
148
+ ## [1.3.0](https://github.com/zfit/phasespace/releases/tag/1.3.0) (28 May 2021)
149
+
150
+ ### Major features and improvements
151
+
152
+ - Python 3.9 is supported.
153
+ - TensorFlow 2.5 is supported.
154
+ - Compilation in `tf.function`s is improved, with XLA used where applicable.
155
+ - For developers: setup, CI and more are modernized.
156
+
157
+ ### Thanks
158
+
159
+ - Remco de Boer for many commits and cleanups.
160
+
161
+ ## [1.2.0](https://github.com/zfit/phasespace/releases/tag/1.2.0) (17 Dec 2020)
162
+
163
+ ### Major features and improvements
164
+
165
+ - Python 3.8 is supported.
166
+ - Eager execution can be enabled with `tf.config.run_functions_eagerly(True)` or the environment variable `PHASESPACE_EAGER`.
167
+ - Random number generation is deterministic via a seed or a `tf.random.Generator` instance.
168
+
169
+ ### Requirement changes
170
+
171
+ - TensorFlow is restricted to 2.3/2.4.
172
+ - TensorFlow Probability is restricted to 0.11/0.12.
173
+
174
+ ### Thanks
175
+
176
+ - Remco de Boer and Stefan Pflüger for discussions on random number generation.
177
+
178
+ ## [1.1.1](https://github.com/zfit/phasespace/releases/tag/1.1.1) (17 Feb 2020)
179
+
180
+ Technical release that switches to manual versioning. No changes to the package.
181
+
182
+ ## [1.1.0](https://github.com/zfit/phasespace/releases/tag/1.1.0) (27 Jan 2020)
183
+
184
+ This release switched to TensorFlow 2.0 eager mode. Please upgrade your TensorFlow installation if possible and change your code (minimal changes) as described under "Behavioral changes". In case this is currently impossible to do, please downgrade to < 1.1.0.
185
+
186
+ ### Major features and improvements
187
+
188
+ - Full TensorFlow 2 compatibility.
189
+
190
+ ### Behavioral changes
191
+
192
+ - `generate` now returns an eager Tensor. This is basically a numpy array wrapped by TensorFlow. To explicitly convert it to a numpy array, use the `numpy()` method of the eager Tensor.
193
+ - `generate_tensor` is now deprecated, `generate` can directly be used instead.
194
+
195
+ ### Requirement changes
196
+
197
+ - TensorFlow 2.0.0 or newer is required.
198
+
199
+ ## [1.0.4](https://github.com/zfit/phasespace/releases/tag/1.0.4) (13 Oct 2019)
200
+
201
+ Release to conda-forge, thanks to Chris Burr.
202
+
203
+ ## [1.0.3](https://github.com/zfit/phasespace/releases/tag/1.0.3) (13 Oct 2019)
204
+
205
+ Release to conda-forge, thanks to Chris Burr. This release cannot be installed with pip; use 1.0.4 instead.
206
+
207
+ ## [1.0.2](https://github.com/zfit/phasespace/releases/tag/1.0.2) (3 Jun 2019)
208
+
209
+ The JOSS paper is added and a problem with Zenodo is fixed.
210
+
211
+ ## [1.0.1](https://github.com/zfit/phasespace/releases/tag/1.0.1) (20 May 2019)
212
+
213
+ First stable release of phasespace.
@@ -0,0 +1,29 @@
1
+ cff-version: 1.2.0
2
+ title: phasespace
3
+ abstract: "phasespace - n-body phase space generation in Python"
4
+ message: >-
5
+ If you use this software, please cite it using the
6
+ metadata from this file.
7
+ doi: 10.21105/joss.01570
8
+ type: software
9
+ repository-code: "https://github.com/zfit/phasespace"
10
+ authors:
11
+ - given-names: Albert
12
+ family-names: Navarro
13
+ orcid: https://orcid.org/0000-0001-8868-2947
14
+ - given-names: Jonas
15
+ family-names: Eschle
16
+ affiliation: University of Zurich
17
+ orcid: https://orcid.org/0000-0002-7312-3699
18
+ - given-names: Remco E.
19
+ family-names: de Boer
20
+ affiliation: Ruhr University Bochum
21
+ orcid: https://orcid.org/0000-0001-5846-2206
22
+ keywords:
23
+ - Python
24
+ - Simulation
25
+ - High Energy Physics
26
+ - Phasespace
27
+ - PWA
28
+ - kinematics
29
+ license: "BSD-3-Clause"