diff --git a/docs/contributing.md b/docs/contributing.md index 3c324ad..5c72f49 100644 --- a/docs/contributing.md +++ b/docs/contributing.md @@ -23,6 +23,8 @@ Current coverage is at 100%, so no untested line will be accepted 😇. > 📣 Know that no code styling formatter (like `black`, or else ...) will ever be imposed in CI, as long as I'm still breathing ! +In case you are interested in contributing, checkout out [current development roadmap 🎯](./devdoc/roadmap.md) + ## Base recipes _A few base memo on how to develop this package ..._ @@ -41,4 +43,5 @@ _A few base memo on how to develop this package ..._ devdoc/addRK devdoc/testing devdoc/updateDoc + devdoc/roadmap ``` diff --git a/docs/devdoc/roadmap.md b/docs/devdoc/roadmap.md new file mode 100644 index 0000000..a75acbf --- /dev/null +++ b/docs/devdoc/roadmap.md @@ -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) \ No newline at end of file