jaxtfwaves 0.2.0__tar.gz → 0.3.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.
- jaxtfwaves-0.3.0/.pre-commit-config.yaml +18 -0
- jaxtfwaves-0.3.0/DEV_PLAN_DOCS.md +209 -0
- jaxtfwaves-0.3.0/DEV_PLAN_TLT_INTEGRATION.md +621 -0
- {jaxtfwaves-0.2.0 → jaxtfwaves-0.3.0}/PKG-INFO +80 -56
- jaxtfwaves-0.3.0/README.md +147 -0
- jaxtfwaves-0.3.0/RELEASE_NOTES_0.3.0.md +39 -0
- {jaxtfwaves-0.2.0 → jaxtfwaves-0.3.0}/notebooks/EMRI.ipynb +368 -266
- {jaxtfwaves-0.2.0 → jaxtfwaves-0.3.0}/notebooks/emri-example-2.ipynb +372 -264
- {jaxtfwaves-0.2.0 → jaxtfwaves-0.3.0}/notebooks/emri-example-tdi.ipynb +622 -441
- {jaxtfwaves-0.2.0 → jaxtfwaves-0.3.0}/notebooks/emri-example.ipynb +442 -318
- {jaxtfwaves-0.2.0 → jaxtfwaves-0.3.0}/notebooks/fd-linear-chirp_example.ipynb +124 -89
- {jaxtfwaves-0.2.0 → jaxtfwaves-0.3.0}/notebooks/linear-chirp-example-multiple-modes.ipynb +186 -115
- {jaxtfwaves-0.2.0 → jaxtfwaves-0.3.0}/notebooks/linear-chirp-example-tdi.ipynb +385 -245
- {jaxtfwaves-0.2.0 → jaxtfwaves-0.3.0}/notebooks/linear-chirp-example.ipynb +188 -117
- {jaxtfwaves-0.2.0 → jaxtfwaves-0.3.0}/notebooks/sobhb-example-ripple.ipynb +734 -456
- {jaxtfwaves-0.2.0 → jaxtfwaves-0.3.0}/notebooks/sobhb-example.ipynb +459 -283
- jaxtfwaves-0.3.0/notebooks/tlt-api-tour.ipynb +172 -0
- {jaxtfwaves-0.2.0 → jaxtfwaves-0.3.0}/pyproject.toml +7 -3
- jaxtfwaves-0.3.0/src/tfwaves/__init__.py +27 -0
- {jaxtfwaves-0.2.0 → jaxtfwaves-0.3.0}/src/tfwaves/response.py +0 -2
- {jaxtfwaves-0.2.0 → jaxtfwaves-0.3.0}/src/tfwaves/stft.py +155 -167
- jaxtfwaves-0.3.0/src/tfwaves/tlt_adapters.py +238 -0
- {jaxtfwaves-0.2.0 → jaxtfwaves-0.3.0}/tests/test_stft.py +10 -11
- jaxtfwaves-0.3.0/tests/test_tlt_adapters.py +201 -0
- {jaxtfwaves-0.2.0 → jaxtfwaves-0.3.0}/uv.lock +53 -289
- jaxtfwaves-0.2.0/.pre-commit-config.yaml +0 -7
- jaxtfwaves-0.2.0/README.md +0 -124
- jaxtfwaves-0.2.0/src/tfwaves/__init__.py +0 -9
- {jaxtfwaves-0.2.0 → jaxtfwaves-0.3.0}/.gitattributes +0 -0
- {jaxtfwaves-0.2.0 → jaxtfwaves-0.3.0}/.gitignore +0 -0
- {jaxtfwaves-0.2.0 → jaxtfwaves-0.3.0}/.gitlab-ci.yml +0 -0
- {jaxtfwaves-0.2.0 → jaxtfwaves-0.3.0}/src/tfplugins/__init__.py +0 -0
- {jaxtfwaves-0.2.0 → jaxtfwaves-0.3.0}/src/tfplugins/sobhbwaveform/__init__.py +0 -0
- {jaxtfwaves-0.2.0 → jaxtfwaves-0.3.0}/src/tfplugins/sobhbwaveform/sobhbparams.py +0 -0
- {jaxtfwaves-0.2.0 → jaxtfwaves-0.3.0}/src/tfplugins/sobhbwaveform/sobhbwaveform_ripple.py +0 -0
- {jaxtfwaves-0.2.0 → jaxtfwaves-0.3.0}/src/tfwaves/interpolation.py +0 -0
- {jaxtfwaves-0.2.0 → jaxtfwaves-0.3.0}/src/tfwaves/utils.py +0 -0
- {jaxtfwaves-0.2.0 → jaxtfwaves-0.3.0}/src/tfwaves/waveform.py +0 -0
- {jaxtfwaves-0.2.0 → jaxtfwaves-0.3.0}/tests/__init__.py +0 -0
- {jaxtfwaves-0.2.0 → jaxtfwaves-0.3.0}/tests/orbits.h5 +0 -0
- {jaxtfwaves-0.2.0 → jaxtfwaves-0.3.0}/tests/test_waveform.py +0 -0
|
@@ -0,0 +1,18 @@
|
|
|
1
|
+
repos:
|
|
2
|
+
- repo: https://github.com/astral-sh/ruff-pre-commit
|
|
3
|
+
rev: v0.6.8
|
|
4
|
+
hooks:
|
|
5
|
+
- id: ruff
|
|
6
|
+
args: [--fix]
|
|
7
|
+
exclude: ^notebooks/.*\.ipynb$
|
|
8
|
+
- id: ruff-format
|
|
9
|
+
exclude: ^notebooks/.*\.ipynb$
|
|
10
|
+
|
|
11
|
+
- repo: local
|
|
12
|
+
hooks:
|
|
13
|
+
- id: pytest
|
|
14
|
+
name: pytest (uv)
|
|
15
|
+
entry: uv run pytest
|
|
16
|
+
language: system
|
|
17
|
+
pass_filenames: false
|
|
18
|
+
stages: [pre-push]
|
|
@@ -0,0 +1,209 @@
|
|
|
1
|
+
# Development Plan: Jupyter Book Documentation (`/docs/`)
|
|
2
|
+
|
|
3
|
+
## Overview
|
|
4
|
+
|
|
5
|
+
This plan describes migrating the existing `notebooks/` directory into a Jupyter Book
|
|
6
|
+
hosted in a new `/docs/` folder. The actual documentation content (API reference,
|
|
7
|
+
narrative pages) will be written after the TLT API integration is complete. This plan
|
|
8
|
+
focuses only on the scaffolding and notebook migration.
|
|
9
|
+
|
|
10
|
+
---
|
|
11
|
+
|
|
12
|
+
## 1. New Directory Structure
|
|
13
|
+
|
|
14
|
+
```
|
|
15
|
+
docs/
|
|
16
|
+
├── _config.yml # Jupyter Book configuration
|
|
17
|
+
├── _toc.yml # Table of contents
|
|
18
|
+
├── intro.md # Landing page
|
|
19
|
+
├── installation.md # Installation guide (from README)
|
|
20
|
+
├── publishing.md # Symlink or copy of PUBLISHING.md
|
|
21
|
+
├── api/
|
|
22
|
+
│ └── index.md # API reference placeholder (filled after TLT integration)
|
|
23
|
+
├── userguides/
|
|
24
|
+
│ └── index.md # User guides landing page
|
|
25
|
+
└── notebooks/ # All notebooks live here (moved from /notebooks/)
|
|
26
|
+
├── linear-chirp-example.ipynb
|
|
27
|
+
├── linear-chirp-example-tdi.ipynb
|
|
28
|
+
├── linear-chirp-example-multiple-modes.ipynb
|
|
29
|
+
├── fd-linear-chirp_example.ipynb
|
|
30
|
+
├── sobhb-example.ipynb
|
|
31
|
+
├── sobhb-example-ripple.ipynb
|
|
32
|
+
├── emri-example.ipynb
|
|
33
|
+
├── emri-example-2.ipynb
|
|
34
|
+
├── emri-example-tdi.ipynb
|
|
35
|
+
└── tlt-api-tour.ipynb # new (from TLT integration plan)
|
|
36
|
+
```
|
|
37
|
+
|
|
38
|
+
---
|
|
39
|
+
|
|
40
|
+
## 2. Dependencies
|
|
41
|
+
|
|
42
|
+
Add to `[dependency-groups]`:
|
|
43
|
+
|
|
44
|
+
```toml
|
|
45
|
+
[dependency-groups]
|
|
46
|
+
docs = [
|
|
47
|
+
"jupyter-book>=1.0.0,<2.0.0",
|
|
48
|
+
"sphinx-autodoc-typehints>=2.0.0,<3.0.0",
|
|
49
|
+
"myst-nb>=1.0.0,<2.0.0",
|
|
50
|
+
]
|
|
51
|
+
```
|
|
52
|
+
|
|
53
|
+
Install with:
|
|
54
|
+
|
|
55
|
+
```bash
|
|
56
|
+
uv sync --group docs
|
|
57
|
+
```
|
|
58
|
+
|
|
59
|
+
---
|
|
60
|
+
|
|
61
|
+
## 3. Jupyter Book Configuration
|
|
62
|
+
|
|
63
|
+
### `docs/_config.yml`
|
|
64
|
+
|
|
65
|
+
```yaml
|
|
66
|
+
title: jaxtfwaves
|
|
67
|
+
author: jaxtfwaves contributors
|
|
68
|
+
logo: ""
|
|
69
|
+
|
|
70
|
+
execute:
|
|
71
|
+
execute_notebooks: "off" # notebooks are pre-executed; set to "auto" in CI if needed
|
|
72
|
+
|
|
73
|
+
parse:
|
|
74
|
+
myst_enable_extensions:
|
|
75
|
+
- colon_fence
|
|
76
|
+
- dollarmath
|
|
77
|
+
|
|
78
|
+
html:
|
|
79
|
+
use_repository_button: true
|
|
80
|
+
use_issues_button: true
|
|
81
|
+
use_edit_page_button: false
|
|
82
|
+
|
|
83
|
+
repository:
|
|
84
|
+
url: https://gitlab.com/your-org/jaxtfwaves
|
|
85
|
+
branch: main
|
|
86
|
+
path_to_book: docs
|
|
87
|
+
```
|
|
88
|
+
|
|
89
|
+
### `docs/_toc.yml`
|
|
90
|
+
|
|
91
|
+
```yaml
|
|
92
|
+
format: jb-book
|
|
93
|
+
root: intro
|
|
94
|
+
|
|
95
|
+
parts:
|
|
96
|
+
- caption: Getting Started
|
|
97
|
+
chapters:
|
|
98
|
+
- file: installation
|
|
99
|
+
- file: publishing
|
|
100
|
+
|
|
101
|
+
- caption: Tutorials
|
|
102
|
+
chapters:
|
|
103
|
+
- file: notebooks/linear-chirp-example
|
|
104
|
+
- file: notebooks/linear-chirp-example-tdi
|
|
105
|
+
- file: notebooks/linear-chirp-example-multiple-modes
|
|
106
|
+
- file: notebooks/fd-linear-chirp_example
|
|
107
|
+
- file: notebooks/sobhb-example
|
|
108
|
+
- file: notebooks/sobhb-example-ripple
|
|
109
|
+
- file: notebooks/emri-example
|
|
110
|
+
- file: notebooks/emri-example-2
|
|
111
|
+
- file: notebooks/emri-example-tdi
|
|
112
|
+
- file: notebooks/tlt-api-tour
|
|
113
|
+
|
|
114
|
+
- caption: API Reference
|
|
115
|
+
chapters:
|
|
116
|
+
- file: api/index
|
|
117
|
+
```
|
|
118
|
+
|
|
119
|
+
---
|
|
120
|
+
|
|
121
|
+
## 4. Migration Steps
|
|
122
|
+
|
|
123
|
+
### 4.1 Move notebooks
|
|
124
|
+
|
|
125
|
+
```bash
|
|
126
|
+
mkdir -p docs/notebooks
|
|
127
|
+
git mv notebooks/*.ipynb docs/notebooks/
|
|
128
|
+
```
|
|
129
|
+
|
|
130
|
+
Update `.gitignore` if needed to exclude `docs/_build/`.
|
|
131
|
+
|
|
132
|
+
### 4.2 Rename the `notebooks/` folder entry in `README.md`
|
|
133
|
+
|
|
134
|
+
Update all references from `notebooks/` to `docs/notebooks/`.
|
|
135
|
+
|
|
136
|
+
### 4.3 Write stub pages
|
|
137
|
+
|
|
138
|
+
- `docs/intro.md` — one-paragraph project description + quick install snippet.
|
|
139
|
+
- `docs/installation.md` — copy the Installation section from `README.md`.
|
|
140
|
+
- `docs/api/index.md` — placeholder: "API reference will be added after TLT integration."
|
|
141
|
+
- `docs/userguides/index.md` — placeholder linking to the tutorials.
|
|
142
|
+
|
|
143
|
+
### 4.4 Build locally
|
|
144
|
+
|
|
145
|
+
```bash
|
|
146
|
+
uv run jupyter-book build docs/
|
|
147
|
+
# open docs/_build/html/index.html in a browser
|
|
148
|
+
```
|
|
149
|
+
|
|
150
|
+
---
|
|
151
|
+
|
|
152
|
+
## 5. CI Integration
|
|
153
|
+
|
|
154
|
+
Add a `docs` job to `.gitlab-ci.yml`:
|
|
155
|
+
|
|
156
|
+
```yaml
|
|
157
|
+
docs:
|
|
158
|
+
stage: build
|
|
159
|
+
script:
|
|
160
|
+
- uv sync --group docs
|
|
161
|
+
- uv run jupyter-book build docs/
|
|
162
|
+
artifacts:
|
|
163
|
+
paths:
|
|
164
|
+
- docs/_build/html/
|
|
165
|
+
expire_in: 1 week
|
|
166
|
+
only:
|
|
167
|
+
- main
|
|
168
|
+
- tags
|
|
169
|
+
```
|
|
170
|
+
|
|
171
|
+
GitLab Pages deployment (optional, add later):
|
|
172
|
+
|
|
173
|
+
```yaml
|
|
174
|
+
pages:
|
|
175
|
+
stage: deploy
|
|
176
|
+
script:
|
|
177
|
+
- cp -r docs/_build/html/ public/
|
|
178
|
+
artifacts:
|
|
179
|
+
paths:
|
|
180
|
+
- public/
|
|
181
|
+
only:
|
|
182
|
+
- main
|
|
183
|
+
```
|
|
184
|
+
|
|
185
|
+
---
|
|
186
|
+
|
|
187
|
+
## 6. Implementation Order
|
|
188
|
+
|
|
189
|
+
> Do this **after** the TLT API integration is complete and tests pass.
|
|
190
|
+
|
|
191
|
+
1. Add `docs` dependency group to `pyproject.toml`.
|
|
192
|
+
2. `git mv notebooks/ docs/notebooks/`.
|
|
193
|
+
3. Create `docs/_config.yml`, `docs/_toc.yml`, `docs/intro.md`, stub pages.
|
|
194
|
+
4. Build locally and fix any broken notebook references.
|
|
195
|
+
5. Add `docs` CI job.
|
|
196
|
+
6. (Later) Add API reference using `sphinx-autodoc` or Jupyter Book's built-in autodoc
|
|
197
|
+
extension once TLT-typed return annotations are in place.
|
|
198
|
+
7. (Later) Add GitLab Pages deployment job.
|
|
199
|
+
|
|
200
|
+
---
|
|
201
|
+
|
|
202
|
+
## 7. Notes
|
|
203
|
+
|
|
204
|
+
- **Do not execute notebooks in CI yet**: notebooks require JAX + orbit files + large
|
|
205
|
+
data; set `execute_notebooks: "off"` and ship pre-executed `.ipynb` files.
|
|
206
|
+
- **Notebook outputs**: strip outputs before committing with `nbstripout` (add to
|
|
207
|
+
pre-commit), or keep them if they serve as rendered examples — decide per notebook.
|
|
208
|
+
- **API reference**: deferred until TLT-typed signatures are stable. At that point,
|
|
209
|
+
`sphinx-autodoc-typehints` will render TLT types cleanly in the HTML output.
|