Skip to content

Commit 28d915a

Browse files
authored
replace dep with future
1 parent 8ea6649 commit 28d915a

1 file changed

Lines changed: 11 additions & 11 deletions

File tree

plans/release-strategy.md

Lines changed: 11 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -9,7 +9,7 @@ This release strategy brings the unified solver architecture to fruition.
99
| Version | Milestone | Focus |
1010
|---------|-----------|-------|
1111
| **0.5.0** | Finalize master/main | Stabilize current codebase |
12-
| **0.6.0** | Python Solver + Unified API + Deprecation | Python solver, `kspaceFirstOrder()` kwargs, deprecation warnings |
12+
| **0.6.0** | Python Solver + Unified API + Deprecation | Python solver, `kspaceFirstOrder()` kwargs, Future warnings |
1313
| **0.6.1** | C-order Migration (Helpers) | Migrate utils/helpers from F-order to C-order, keep legacy API working |
1414
| **0.6.2** | Example Migration | Port remaining examples to new `kspaceFirstOrder()` API |
1515
| **0.6.3** | Axisymmetric Support | Axisymmetric solver in new API, port AS examples |
@@ -30,7 +30,7 @@ This release strategy brings the unified solver architecture to fruition.
3030

3131
---
3232

33-
## Phase 2: v0.6.0 - Native Solver + Unified API + Deprecation
33+
## Phase 2: v0.6.0 - Native Solver + Unified API + Future
3434

3535
**Goal:** Ship a pure Python/CuPy native solver, create a single entry point with kwargs, and deprecate the old API. Three things in one release.
3636

@@ -100,14 +100,14 @@ def kspaceFirstOrder2D(kgrid, source, sensor, medium,
100100

101101
**Create:** `kwave/solvers/serializer.py` - Simple HDF5 writer (~200 lines)
102102

103-
### 2c: Deprecation Warnings
103+
### 2c: Future Warnings
104104

105-
**Add deprecation warnings on old API:**
105+
**Add Future warnings on old API:**
106106
```python
107107
warnings.warn(
108108
"SimulationOptions is deprecated. Use kspaceFirstOrder() kwargs instead. "
109109
"See https://waltersimson.com/k-wave-python/migration",
110-
DeprecationWarning
110+
FutureWarning
111111
)
112112
```
113113

@@ -120,13 +120,13 @@ warnings.warn(
120120
- `tests/test_native_solver.py` - parity with C++ backend
121121
- `tests/test_cupy_backend.py` - GPU acceleration (when CUDA available)
122122
- `tests/test_unified_api.py` - new kwargs API
123-
- `tests/test_deprecation_warnings.py` - verify warnings emitted
123+
- `tests/test_Future_warnings.py` - verify warnings emitted
124124

125125
---
126126

127127
## Phase 2.1: v0.6.1 - C-order Migration (Helpers)
128128

129-
**Goal:** Migrate helper/utility code from Fortran-order to C-order internally, while keeping the legacy API functional. No structural API changes — deprecation warnings only. Fix hacky shaping/indexing throughout.
129+
**Goal:** Migrate helper/utility code from Fortran-order to C-order internally, while keeping the legacy API functional. No structural API changes — Future warnings only. Fix hacky shaping/indexing throughout.
130130

131131
**Scope:** 55 occurrences of `order="F"` across 10 files. Migrate where possible, keep F-order only at explicit boundaries.
132132

@@ -338,7 +338,7 @@ result = kspaceFirstOrder(kgrid, medium, source, sensor,
338338

339339
**Cross-cutting:**
340340
- `tests/test_backend_parity.py` — Python vs C++ backends produce same results for shared test cases
341-
- `tests/test_deprecation_warnings.py` — verify FutureWarning emitted on legacy API calls
341+
- `tests/test_Future_warnings.py` — verify FutureWarning emitted on legacy API calls
342342

343343
---
344344

@@ -369,8 +369,8 @@ result = kspaceFirstOrder(kgrid, medium, source, sensor, backend='native')
369369
print('Success:', result['p'].shape)
370370
"
371371

372-
# v0.6.0 - Deprecation warnings
373-
uv run python -W error::DeprecationWarning -c "
372+
# v0.6.0 - Future warnings
373+
uv run python -W error::FutureWarning -c "
374374
from kwave.options.simulation_options import SimulationOptions
375375
" # Should warn
376376

@@ -383,7 +383,7 @@ uv run pytest tests/ -v
383383
## Implementation Order
384384

385385
1. **Now:** Finalize master/main for v0.5.0
386-
2. **Next:** Python solver + `kspaceFirstOrder()` API + deprecation for v0.6.0
386+
2. **Next:** Python solver + `kspaceFirstOrder()` API + Future for v0.6.0
387387
3. **Then:** C-order migration of helpers/utils for v0.6.1
388388
4. **Then:** Port remaining examples to new API for v0.6.2
389389
5. **Then:** Axisymmetric support in new API for v0.6.3

0 commit comments

Comments
 (0)