jaxtfwaves 0.2.0__py3-none-any.whl

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.
@@ -0,0 +1,144 @@
1
+ Metadata-Version: 2.4
2
+ Name: jaxtfwaves
3
+ Version: 0.2.0
4
+ Summary: Fast time-frequency gravitational-wave response package for LISA data analysis with a JAX backend
5
+ Author-email: Quentin Baghi <quentin.baghi@protonmail.com>, Gael Servignat <servignat@apc.in2p3.fr>, Saptarshi Ghosh <saptarshi.ghosh@apc.in2p3.fr>
6
+ Requires-Python: <3.14,>=3.11
7
+ Requires-Dist: flax==0.12.0
8
+ Requires-Dist: h5py<4.0.0,>=3.14.0
9
+ Requires-Dist: jax==0.9.2
10
+ Requires-Dist: jaxlib==0.9.2
11
+ Requires-Dist: lisaconstants<3.0.0,>=2.0.1
12
+ Requires-Dist: matplotlib
13
+ Requires-Dist: numpy
14
+ Requires-Dist: scipy
15
+ Provides-Extra: plugins
16
+ Requires-Dist: ripplegw<0.0.10,>=0.0.9; extra == 'plugins'
17
+ Provides-Extra: sobhbwaveform
18
+ Requires-Dist: ripplegw<0.0.10,>=0.0.9; extra == 'sobhbwaveform'
19
+ Description-Content-Type: text/markdown
20
+
21
+ # jaxtfwaves
22
+ JAXTFwaves is the sibling project of [tfwaves](https://gitlab.in2p3.fr/lisa-apc/tfwaves) that is using JAX as backend.
23
+
24
+ # tfwaves
25
+ TFWaves is a python package to compute fast time-frequency gravitational-wave response for LISA data analysis. It takes as imput phase and amplitude functions of the gravitational strain in the pseudo-inertial solar system barycenter frame, and outputs time-delay interferometry responses in the time-frequency domain.
26
+
27
+ ## Installation
28
+
29
+ The core package is available on PyPI:
30
+
31
+ ```bash
32
+ pip install jaxtfwaves
33
+ ```
34
+
35
+ To install a specific plugin, use its named extra:
36
+
37
+ ```bash
38
+ pip install "jaxtfwaves[sobhbwaveform]" # SOBHB waveforms via ripplegw
39
+ # pip install "jaxtfwaves[emriwaveform]" # EMRI waveforms (coming soon)
40
+ ```
41
+
42
+ Or install all available plugins at once:
43
+
44
+ ```bash
45
+ pip install "jaxtfwaves[plugins]"
46
+ ```
47
+
48
+ ## Contributing
49
+
50
+ ### Development environment
51
+
52
+ We use [uv](https://docs.astral.sh/uv/) for dependency management.
53
+ First clone the repository on your machine and go in the directory:
54
+
55
+ ```bash
56
+ git clone git@gitlab.in2p3.fr:lisa-apc/tfwaves.git
57
+ cd jaxtfwaves
58
+ ```
59
+
60
+ Create the lockfile and synchronize dependencies (including development tools):
61
+
62
+ ```bash
63
+ uv sync --all-extras --group dev
64
+ ```
65
+
66
+ We recommend you install pre-commit hooks to detect errors before you even
67
+ commit.
68
+
69
+ ```bash
70
+ uv run pre-commit install
71
+ ```
72
+
73
+ Then you can run any script using
74
+
75
+ ```bash
76
+ uv run python your_script.py
77
+ ```
78
+
79
+ Lint and format checks are handled with Ruff:
80
+
81
+ ```bash
82
+ uv run ruff check src tests
83
+ uv run ruff format --check src tests
84
+ ```
85
+
86
+ Alternatively, you can activate the virtual environment by running
87
+
88
+ ```bash
89
+ source .venv/bin/activate
90
+ ```
91
+ and deactivate it by just running
92
+
93
+ ```bash
94
+ deactivate
95
+ ```
96
+
97
+ ### Alternative local installation
98
+
99
+ As an alternative to uv-managed environments, you can install the package in development mode when you are in the `jaxtfwaves` directory:
100
+
101
+ ```bash
102
+ pip install -e . # core only
103
+ pip install -e ".[plugins]" # core + plugins
104
+ ```
105
+
106
+ ## Publishing to PyPI
107
+
108
+ 1. **Build** the package (from the repo root):
109
+
110
+ ```bash
111
+ uv build
112
+ ```
113
+
114
+ 2. **Check** the artifacts:
115
+
116
+ ```bash
117
+ uv run twine check dist/*
118
+ ```
119
+
120
+ 3. **Upload to TestPyPI** first:
121
+
122
+ ```bash
123
+ uv publish --publish-url https://test.pypi.org/legacy/ --token pypi-YOUR_TEST_TOKEN
124
+ ```
125
+
126
+ Verify the install:
127
+
128
+ ```bash
129
+ pip install --index-url https://test.pypi.org/simple/ --extra-index-url https://pypi.org/simple jaxtfwaves
130
+ pip install --index-url https://test.pypi.org/simple/ --extra-index-url https://pypi.org/simple "jaxtfwaves[plugins]"
131
+ ```
132
+
133
+ 4. **Upload to PyPI**:
134
+
135
+ ```bash
136
+ uv publish --token pypi-YOUR_TOKEN
137
+ ```
138
+
139
+ 5. **Tag the release**:
140
+
141
+ ```bash
142
+ git tag v0.1.0
143
+ git push origin v0.1.0
144
+ ```
@@ -0,0 +1,14 @@
1
+ tfplugins/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
2
+ tfplugins/sobhbwaveform/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
3
+ tfplugins/sobhbwaveform/sobhbparams.py,sha256=R6PfdOcVZJ2BUX01mc-WmcZC9vMInlXdBv0vrYICHtc,19074
4
+ tfplugins/sobhbwaveform/sobhbwaveform_ripple.py,sha256=8bRyHvsXUjCwfYjc8-1eQwQ1iDzadnd3iILmiT3OmS4,14974
5
+ tfwaves/__init__.py,sha256=GWhytDNtsDOBhQIj8bKJsKzdrnE3mN9G3B68JXnaoLg,206
6
+ tfwaves/interpolation.py,sha256=3N-xuv9NAWaOwMXMQwiBgeEAguzym2f7t4Gen_cFdaU,9558
7
+ tfwaves/response.py,sha256=g2WmsDtV47_Qh69dKkiFGuj5TB-w5ZNFzeK71DIfRU4,23406
8
+ tfwaves/stft.py,sha256=BE7RY_kV7nVOFIPQIdDcnWX0TglQkvZPrNiZYa9Ltm8,30109
9
+ tfwaves/utils.py,sha256=UO8PiBUFMxSC3hOkNdwLd79-7T2w2cifIy5rbrbLiB8,18673
10
+ tfwaves/waveform.py,sha256=vVDooOLgbQdZxi0TxQMe87w8fjUqnyR-mx6f6t9Mp9c,12281
11
+ jaxtfwaves-0.2.0.dist-info/METADATA,sha256=3jX1dMMXv0Spsi8shB45bOjxejYZWOc00s4VE4uPOlg,3556
12
+ jaxtfwaves-0.2.0.dist-info/WHEEL,sha256=QccIxa26bgl1E6uMy58deGWi-0aeIkkangHcxk2kWfw,87
13
+ jaxtfwaves-0.2.0.dist-info/entry_points.txt,sha256=yGwwHWB3rHbCCnoj6RNeRw7S_wVdoFRYiTVjL4wTajc,51
14
+ jaxtfwaves-0.2.0.dist-info/RECORD,,
@@ -0,0 +1,4 @@
1
+ Wheel-Version: 1.0
2
+ Generator: hatchling 1.29.0
3
+ Root-Is-Purelib: true
4
+ Tag: py3-none-any
@@ -0,0 +1,2 @@
1
+ [console_scripts]
2
+ precommit = pre_commit.main:main
tfplugins/__init__.py ADDED
File without changes
File without changes