Skip to content

Commit 37ccd22

Browse files
Merge pull request #1862 from OceanParcels/extend_v4_docpage_background
Adding more background to v4 development on the v4-docpage
2 parents 02f728c + d7bf01b commit 37ccd22

File tree

1 file changed

+13
-3
lines changed

1 file changed

+13
-3
lines changed

docs/v4/index.md

Lines changed: 13 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,11 +1,21 @@
1-
# v4 development
1+
# Parcels v4 development
22

3-
This is a central hub to discuss the development of v4. As development progresses, some of the pages mentioned here will be incorporated into the main documentation.
3+
Supported by funding from the [WarmWorld](https://www.warmworld.de) [ELPHE](https://www.kooperation-international.de/foerderung/projekte/detail/info/warmworld-elphe-ermoeglichung-von-lagranian-particle-tracking-fuer-hochaufloesende-und-unstrukturierte-gitter) 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.
44

5-
You can think of this as a "living" document as we work towards the release of v4.
5+
The key goals of this update are
6+
7+
1. to support `Fields` on unstructured grids;
8+
2. to allow for user-defined interpolation methods (somewhat similar to user-defined kernels);
9+
3. to make the codebase more modular, easier to extend, and more maintainable;
10+
4. to align Parcels more with other tools in the [Pangeo ecosystemand](https://www.pangeo.io/#ecosystem), particularly by leveraging `xarray` more; and
11+
5. to improve the performance of Parcels.
12+
13+
The timeline for the release of Parcels v4 is not yet fixed, but we are aiming for a release of an 'alpha' version in September 2025. This v4-alpha will have support for unstructured grids and user-defined interpolation methods, but is not yet performance-optimised.
614

715
Collaboration on v4 development is happening on the [Parcels v4 Project Board](https://github.com/orgs/OceanParcels/projects/5).
816

17+
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.
18+
919
```{toctree}
1020
1121
api

0 commit comments

Comments
 (0)