From 05385799f0412f74c2eb4262c7a4fc2fcc2ca083 Mon Sep 17 00:00:00 2001 From: Michael Denes Date: Fri, 14 Aug 2026 10:15:14 +0200 Subject: [PATCH 1/6] Update docs to include the copernicus marine example. --- docs/examples.rst | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/docs/examples.rst b/docs/examples.rst index db8e82a..4cb0749 100644 --- a/docs/examples.rst +++ b/docs/examples.rst @@ -1,7 +1,7 @@ Examples ======== -``plasticparcels`` has a few example notebooks, see below. Most of these examples require hydrodynamic, physical, and biogeochemical model data, however, the idealised flow example requires no additional data. +``plasticparcels`` has a few example notebooks, see below. Most of these examples require hydrodynamic, physical, and biogeochemical model data, however, the idealised flow example requires no additional data and the copernicus marine example streams data from the Copernicus Marine Service. @@ -9,10 +9,10 @@ Examples :caption: Running simulations :name: running-simulations + examples/example_copernicus_marine.ipynb examples/example_Italy_coast.ipynb examples/example_Greece_coast.ipynb examples/example_Croatian_fisheries.ipynb examples/example_add_your_own_kernel.ipynb examples/example_initialisation_maps.ipynb examples/example_idealised_flow.ipynb - From 52c10d755d3903d39e758aff42f1704d3f168bc4 Mon Sep 17 00:00:00 2001 From: Michael Denes Date: Fri, 14 Aug 2026 10:59:39 +0200 Subject: [PATCH 2/6] Update project readme to highlight copernicusmarine integration --- README.md | 4 ++++ 1 file changed, 4 insertions(+) diff --git a/README.md b/README.md index 288ac9c..b8c36d4 100644 --- a/README.md +++ b/README.md @@ -17,6 +17,10 @@ conda install conda-forge::plasticparcels `plasticparcels` has been developed for use with data from the Copernicus Marine Service, and requires the following data to run: +Option A - Using data streamed from the `copernicusmarine` toolkit. +* `plasticparcels` should work seamlessly with any of the rectilinear datasets available in the `copernicusmarine` toolkit + +Option B - Using hydrodynamic, biogeochemical and wind/wave model data from global reanalysis products * Hydrodynamic model data: [MOI GLO12 (psy4v3r1)](https://www.mercator-ocean.eu/en/solutions-expertise/accessing-digital-data/product-details/?offer=4217979b-2662-329a-907c-602fdc69c3a3&system=d35404e4-40d3-59d6-3608-581c9495d86a) * Biogeochemical model data: [MOI BIO4 (biomer4v2r1)](https://www.mercator-ocean.eu/en/solutions-expertise/accessing-digital-data/product-details/?offer=8d0c01f3-81c7-0a59-0d06-602fdf63c5b6&system=dc40b324-7de7-0732-880b-5d9dcf7d344a) * Wave data: [ECMWF ERA5 Wave](https://cds.climate.copernicus.eu/cdsapp#!/dataset/reanalysis-era5-single-levels) (specifically, the variables `mean_wave_period`, `peak_wave_period`, `u_component_stokes_drift`, and `v_component_stokes_drift`.) From 9aeef651de0ec56b8eefa0966f30005def6ab699 Mon Sep 17 00:00:00 2001 From: Michael Denes Date: Fri, 14 Aug 2026 11:01:50 +0200 Subject: [PATCH 3/6] Also update the readthedocs page --- docs/index.rst | 4 ++++ 1 file changed, 4 insertions(+) diff --git a/docs/index.rst b/docs/index.rst index cb38b2c..89bded5 100644 --- a/docs/index.rst +++ b/docs/index.rst @@ -30,6 +30,10 @@ Required Data ``plasticparcels`` has been developed for use with data from the Copernicus Marine Service, and requires the following data to run: +Option A - Using data streamed from the ``copernicusmarine`` toolkit. +* ``plasticparcels``` should work seamlessly with any of the rectilinear datasets available in the ``copernicusmarine`` toolkit + +Option B - Using hydrodynamic, biogeochemical and wind/wave model data from global reanalysis products * Hydrodynamic model data: `MOI GLO12 (psy4v3r1) `_ * Biogeochemical model data: `MOI BIO4 (biomer4v2r1) `_ * Wave data: `ECMWF ERA5 Wave `_ (specifically, the variables ``mean_wave_period``, ``peak_wave_period``, ``u_component_stokes_drift``, and ``v_component_stokes_drift``.) From e42ee8353a2c64d1a1b08f46e43f3824cdab50b6 Mon Sep 17 00:00:00 2001 From: Michael Denes Date: Fri, 14 Aug 2026 11:51:38 +0200 Subject: [PATCH 4/6] Fixing bulletpoints in readthedocs --- README.md | 6 ++++-- docs/index.rst | 6 ++++-- 2 files changed, 8 insertions(+), 4 deletions(-) diff --git a/README.md b/README.md index b8c36d4..0a63fd6 100644 --- a/README.md +++ b/README.md @@ -17,10 +17,12 @@ conda install conda-forge::plasticparcels `plasticparcels` has been developed for use with data from the Copernicus Marine Service, and requires the following data to run: -Option A - Using data streamed from the `copernicusmarine` toolkit. +**Option A** - Using data streamed from the `copernicusmarine` toolkit. + * `plasticparcels` should work seamlessly with any of the rectilinear datasets available in the `copernicusmarine` toolkit -Option B - Using hydrodynamic, biogeochemical and wind/wave model data from global reanalysis products +**Option B** - Using hydrodynamic, biogeochemical and wind/wave model data from global reanalysis products + * Hydrodynamic model data: [MOI GLO12 (psy4v3r1)](https://www.mercator-ocean.eu/en/solutions-expertise/accessing-digital-data/product-details/?offer=4217979b-2662-329a-907c-602fdc69c3a3&system=d35404e4-40d3-59d6-3608-581c9495d86a) * Biogeochemical model data: [MOI BIO4 (biomer4v2r1)](https://www.mercator-ocean.eu/en/solutions-expertise/accessing-digital-data/product-details/?offer=8d0c01f3-81c7-0a59-0d06-602fdf63c5b6&system=dc40b324-7de7-0732-880b-5d9dcf7d344a) * Wave data: [ECMWF ERA5 Wave](https://cds.climate.copernicus.eu/cdsapp#!/dataset/reanalysis-era5-single-levels) (specifically, the variables `mean_wave_period`, `peak_wave_period`, `u_component_stokes_drift`, and `v_component_stokes_drift`.) diff --git a/docs/index.rst b/docs/index.rst index 89bded5..6fea3ac 100644 --- a/docs/index.rst +++ b/docs/index.rst @@ -30,10 +30,12 @@ Required Data ``plasticparcels`` has been developed for use with data from the Copernicus Marine Service, and requires the following data to run: -Option A - Using data streamed from the ``copernicusmarine`` toolkit. +**Option A** - Using data streamed from the ``copernicusmarine`` toolkit. + * ``plasticparcels``` should work seamlessly with any of the rectilinear datasets available in the ``copernicusmarine`` toolkit -Option B - Using hydrodynamic, biogeochemical and wind/wave model data from global reanalysis products +**Option B** - Using hydrodynamic, biogeochemical and wind/wave model data from global reanalysis products + * Hydrodynamic model data: `MOI GLO12 (psy4v3r1) `_ * Biogeochemical model data: `MOI BIO4 (biomer4v2r1) `_ * Wave data: `ECMWF ERA5 Wave `_ (specifically, the variables ``mean_wave_period``, ``peak_wave_period``, ``u_component_stokes_drift``, and ``v_component_stokes_drift``.) From 24a69486da04c3484ecc3ef3b568f5ff0203719a Mon Sep 17 00:00:00 2001 From: Michael Denes Date: Fri, 14 Aug 2026 14:28:25 +0200 Subject: [PATCH 5/6] Use correct name of copernicusmarine example in docs --- docs/examples.rst | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/examples.rst b/docs/examples.rst index 4cb0749..34c095a 100644 --- a/docs/examples.rst +++ b/docs/examples.rst @@ -9,7 +9,7 @@ Examples :caption: Running simulations :name: running-simulations - examples/example_copernicus_marine.ipynb + examples/example_copernicusmarine.ipynb examples/example_Italy_coast.ipynb examples/example_Greece_coast.ipynb examples/example_Croatian_fisheries.ipynb From 41f650faf17f78a96af44e656de860b9ae53e7b7 Mon Sep 17 00:00:00 2001 From: Michael Denes Date: Fri, 14 Aug 2026 15:05:58 +0200 Subject: [PATCH 6/6] Update readme and index based on Erik's comments --- README.md | 2 +- docs/index.rst | 2 +- 2 files changed, 2 insertions(+), 2 deletions(-) diff --git a/README.md b/README.md index 0a63fd6..6b51b4e 100644 --- a/README.md +++ b/README.md @@ -19,7 +19,7 @@ conda install conda-forge::plasticparcels **Option A** - Using data streamed from the `copernicusmarine` toolkit. -* `plasticparcels` should work seamlessly with any of the rectilinear datasets available in the `copernicusmarine` toolkit +* `plasticparcels` should work seamlessly with any of the datasets available in the `copernicusmarine` toolkit **Option B** - Using hydrodynamic, biogeochemical and wind/wave model data from global reanalysis products diff --git a/docs/index.rst b/docs/index.rst index 6fea3ac..9514001 100644 --- a/docs/index.rst +++ b/docs/index.rst @@ -32,7 +32,7 @@ Required Data **Option A** - Using data streamed from the ``copernicusmarine`` toolkit. -* ``plasticparcels``` should work seamlessly with any of the rectilinear datasets available in the ``copernicusmarine`` toolkit +* ``plasticparcels``` should work seamlessly with any of the datasets available in the ``copernicusmarine`` toolkit **Option B** - Using hydrodynamic, biogeochemical and wind/wave model data from global reanalysis products