Skip to content

Adding more background to v4 development on the v4-docpage #1862

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
erikvansebille merged 2 commits into from
Feb 14, 2025
Merged

Adding more background to v4 development on the v4-docpage #1862

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
2d60885
Adding more background to v4 development on the v4-docpage
erikvansebille Feb 14, 2025
d7bf01b
Adding Pangeo ecosystem alignment to v4 docs
erikvansebille Feb 14, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
16 changes: 13 additions & 3 deletions docs/v4/index.md
View file
Open in desktop
Copy link
Copy Markdown
Contributor

@VeckoTheGecko VeckoTheGecko Feb 14, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Would it be beneficial to mention alignment with xarray/the Pangeo ecosystem here? (as a point 5) I think it would be interesting for Pangeo users/users who were aware of the previously eager from_xarray() methods in v3 :)

Otherwise looks good to me

Original file line number Diff line number Diff line change
@@ -1,11 +1,21 @@
# v4 development
# Parcels v4 development

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.
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.

You can think of this as a "living" document as we work towards the release of v4.
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 ecosystemand](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 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.

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

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}

api
Expand Down
Loading