diff --git a/docs/user_guide/group_misc.md b/docs/user_guide/group_misc.md index 516ae1596..01eb1412f 100644 --- a/docs/user_guide/group_misc.md +++ b/docs/user_guide/group_misc.md @@ -1,6 +1,5 @@ ```{toctree} :titlesonly: -📖 v4 development <../v4/index> 🎓 v3 to v4 migration guide misc_homepage_animation.md ``` diff --git a/docs/v4/index.md b/docs/v4/index.md deleted file mode 100644 index 851bd9789..000000000 --- a/docs/v4/index.md +++ /dev/null @@ -1,21 +0,0 @@ -# 📖 Parcels v4 development - -Supported by funding from the [WarmWorld](https://www.warmworld.de) [ELPHE](https://www.geomar.de/en/research/ongoing-projects/project-details/prj/376612?cHash=449a07d057ea0d890287bd2b8ca26e8b) project and an [NWO Vici project](https://www.nwo.nl/en/researchprogrammes/nwo-talent-programme/projects-vici/vici-2022), the Parcels team is working on a major update to the Parcels codebase. - -The key goals of this update are - -1. to support `Fields` on unstructured grids; -2. to allow for user-defined interpolation methods (somewhat similar to user-defined kernels); -3. to make the codebase more modular, easier to extend, and more maintainable; -4. to align Parcels more with other tools in the [Pangeo ecosystem](https://www.pangeo.io/#ecosystem), particularly by leveraging `xarray` more; and -5. to improve the performance of Parcels. - -The timeline for the release of Parcels v4 is not yet fixed, but we are aiming for an early release in September 2026. This v4.0 will have support for unstructured grids and user-defined interpolation methods, but is not yet performance-optimised. It is meant to gather user feedback and should not be considered stable. - -The pages below provide further background on the development of Parcels v4. You can think of this page as a "living" document as we work towards the release of v4. - -```{toctree} -nojit -Parcels v4 Issue Tracker -Parcels v4 migration guide <../user_guide/v4-migration> -``` diff --git a/docs/v4/nojit.md b/docs/v4/nojit.md deleted file mode 100644 index 2959f81b4..000000000 --- a/docs/v4/nojit.md +++ /dev/null @@ -1,16 +0,0 @@ -# Rationale for dropping JIT support in v4 - -Parcels v4 will not support Just-In-Time (JIT) compilation. This means that the `JITParticle` class will be removed from the codebase. This decision was made for the following reasons: - -1. We want to leverage the power of `xarray` and `uxarray` for data handling and interpolation. These libraries are not compatible with the JIT compilation in v3. -2. We want to make the codebase more maintainable and easier to understand. The JIT compilation pre-v4 adds complexity to the codebase and makes it harder to debug and maintain. -3. We have quite a few features in Parcels (also v3) that only work in Scipy mode (particle-particle interaction, particle-field interaction, etc.). -4. We want users to write more flexible/complex kernels. JIT doesn't support calling functions, or using methods from `numpy` or `scipy`, while this is possible in Scipy mode. - -Essentially, the only advantage of JIT was its speed. But now that the ecosystem for just-in-time compilation with python has matured in the last 10 years, we want to leverage other packages and methods (`cython`, `numba`, `jax`?) and Python internals for speed-up. - -Furthermore, we think we have some good ideas how to speed up Parcels itself without JIT compilation, such as relying more on vectorized operations. - -In short, we think that the disadvantages of JIT in Parcels v3 outweigh the advantages, and we want to make Parcels v4 a more modern and maintainable codebase. - -In our development of v4, we will first focus on making the codebase more modular and easier to extend. Once we have a working codebase, we will release this as `v4-alpha`. After that, we will start working on performance improvements.