-
Notifications
You must be signed in to change notification settings - Fork 2
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
TL: added roadmap before I forget ...
- Loading branch information
Showing
2 changed files
with
39 additions
and
0 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,36 @@ | ||
# Development Roadmap | ||
|
||
📜 _Planned steps for the package development ..._ | ||
|
||
**Status 3 - Alpha** : `v0.0.*` | ||
|
||
- ✅ main structure and design | ||
- ✅ full testing | ||
- ✅ base documentation (notebook) | ||
- ✅ documentation website (readthedocs) | ||
- ✅ developer documentation | ||
- ✅ pypi packaging and full installation doc | ||
- ✅ github community compliance | ||
- structure for embedded $Q$-coefficients and integration of those from [pySDC](https://github.com/Parallel-in-Time/pySDC) | ||
|
||
**Status 4 - Beta** : `v0.1.*` | ||
|
||
- citation file and zenodo releases | ||
- integration of `qmat` into [pySDC](https://github.com/Parallel-in-Time/pySDC) | ||
- full documentation of classes and functions | ||
- finalization of extended usage tutorials ($S$-matrix, `dTau` coefficient for initial sweep, prolongation) | ||
|
||
**Status 5 - Production/Stable** : `v1.0.*` | ||
|
||
- base console script interfacing `qmat` API for $Q$-coefficients and SDC coefficients generation (with IMEX) | ||
- integration of `qmat` into [SWEET](https://gitlab.inria.fr/sweet/sweet) | ||
- use of `qmat` for [Dedalus](https://github.com/DedalusProject/dedalus) IMEX SDC time-steppers developed within [pySDC](https://github.com/Parallel-in-Time/pySDC) | ||
- distribution to other people using former version of the core `qmat` code (_e.g_ Alex Brown from Exeter, ...) | ||
- addition of a few advanced usage tutorials : | ||
- `qmat` for non-linear ODE | ||
- multilevel SDC | ||
- PFASST | ||
|
||
**Status 6 - Mature** : `v1.*.*` | ||
|
||
- [ ] integration of SDC-Butcher theory from J. Fregin (with associated console scripts) |