Add parcels._datasets.remote (#2574)

Co-authored-by: Erik van Sebille <e.vansebille@uu.nl>

Author: VeckoTheGecko

.github/ci/recipe.yaml

@@ -35,7 +35,7 @@ requirements:
     - netcdf4 >=1.7.2
     - numpy >=2.1.0
     - tqdm >=4.50.0
-    - xarray >=2024.5.0
+    - xarray >=2025.8.0
     - cf_xarray >=0.8.6
     - xgcm >=0.9.0
     - zarr >=2.15.0,!=2.18.0,<3

docs/getting_started/tutorial_output.ipynb

@@ -35,7 +35,8 @@
     "import numpy as np\n",
     "import xarray as xr\n",
     "\n",
-    "import parcels"
+    "import parcels\n",
+    "import parcels.tutorial"
    ]
   },
   {
@@ -52,11 +53,9 @@
    "outputs": [],
    "source": [
     "# Load the CopernicusMarine data in the Agulhas region from the example_datasets\n",
-    "example_dataset_folder = parcels.download_example_dataset(\n",
-    "    \"CopernicusMarine_data_for_Argo_tutorial\"\n",
+    "ds_fields = parcels.tutorial.open_dataset(\n",
+    "    \"CopernicusMarine_data_for_Argo_tutorial/data\"\n",
     ")\n",
-    "\n",
-    "ds_fields = xr.open_mfdataset(f\"{example_dataset_folder}/*.nc\", combine=\"by_coords\")\n",
     "ds_fields.load()  # load the dataset into memory\n",
     "\n",
     "# Convert to SGRID-compliant dataset and create FieldSet\n",
@@ -558,7 +557,7 @@
  "metadata": {
   "celltoolbar": "Metagegevens bewerken",
   "kernelspec": {
-   "display_name": "test-notebooks",
+   "display_name": "default",
    "language": "python",
    "name": "python3"
   },
@@ -572,7 +571,7 @@
    "name": "python",
    "nbconvert_exporter": "python",
    "pygments_lexer": "ipython3",
-   "version": "3.14.2"
+   "version": "3.14.3"
   }
  },
  "nbformat": 4,

docs/getting_started/tutorial_quickstart.md

@@ -20,6 +20,7 @@ and writing output files that can be read with xarray.
 import numpy as np
 import xarray as xr
 import parcels
+import parcels.tutorial
 ```
 
 ## Input flow fields: `FieldSet`
@@ -29,11 +30,8 @@ hydrodynamics fields in which the particles are tracked. Here we provide an exam
 [Global Ocean Physics Reanalysis](https://doi.org/10.48670/moi-00021) from the Copernicus Marine Service.
 
 ```{code-cell}
-example_dataset_folder = parcels.download_example_dataset(
-    "CopernicusMarine_data_for_Argo_tutorial"
-)
+ds_fields = parcels.tutorial.open_dataset("CopernicusMarine_data_for_Argo_tutorial/data")
 
-ds_fields = xr.open_mfdataset(f"{example_dataset_folder}/*.nc", combine="by_coords")
 ds_fields.load()  # load the dataset into memory
 ds_fields
 ```

docs/user_guide/examples/explanation_kernelloop.md

@@ -53,13 +53,10 @@ import numpy as np
 import xarray as xr
 
 import parcels
+import parcels.tutorial
 
 # Load the CopernicusMarine data in the Agulhas region from the example_datasets
-example_dataset_folder = parcels.download_example_dataset(
-    "CopernicusMarine_data_for_Argo_tutorial"
-)
-
-ds_fields = xr.open_mfdataset(f"{example_dataset_folder}/*.nc", combine="by_coords")
+ds_fields = parcels.tutorial.open_dataset("CopernicusMarine_data_for_Argo_tutorial/data")
 ds_fields.load()  # load the dataset into memory
 
 # Create an idealised wind field and add it to the dataset

docs/user_guide/examples/tutorial_Argofloats.ipynb

@@ -110,14 +110,13 @@
     "import xarray as xr\n",
     "\n",
     "import parcels\n",
+    "import parcels.tutorial\n",
     "\n",
     "# Load the CopernicusMarine data in the Agulhas region from the example_datasets\n",
-    "example_dataset_folder = parcels.download_example_dataset(\n",
-    "    \"CopernicusMarine_data_for_Argo_tutorial\"\n",
+    "ds_fields = parcels.tutorial.open_dataset(\n",
+    "    \"CopernicusMarine_data_for_Argo_tutorial/data\"\n",
     ")\n",
     "\n",
-    "ds_fields = xr.open_mfdataset(f\"{example_dataset_folder}/*.nc\", combine=\"by_coords\")\n",
-    "\n",
     "# TODO check how we can get good performance without loading full dataset in memory\n",
     "ds_fields.load()  # load the dataset into memory\n",
     "\n",

docs/user_guide/examples/tutorial_croco_3D.ipynb

@@ -34,16 +34,7 @@
    "metadata": {},
    "outputs": [],
    "source": [
-    "import matplotlib.pyplot as plt\n",
-    "import numpy as np\n",
-    "import xarray as xr\n",
-    "\n",
-    "import parcels\n",
-    "\n",
-    "data_folder = parcels.download_example_dataset(\"CROCOidealized_data\")\n",
-    "ds_fields = xr.open_dataset(data_folder / \"CROCO_idealized.nc\")\n",
-    "\n",
-    "ds_fields.load();  # Preload data to speed up access"
+    "import matplotlib.pyplot as plt\nimport numpy as np\nimport xarray as xr\n\nimport parcels\nimport parcels.tutorial\n\nds_fields = parcels.tutorial.open_dataset(\"CROCOidealized_data/data\")\n\nds_fields.load();  # Preload data to speed up access"
    ]
   },
   {

docs/user_guide/examples/tutorial_delaystart.ipynb

@@ -30,6 +30,7 @@
     "from matplotlib.animation import FuncAnimation\n",
     "\n",
     "import parcels\n",
+    "import parcels.tutorial\n",
     "\n",
     "# for interactive display of animations\n",
     "plt.rcParams[\"animation.html\"] = \"jshtml\""
@@ -50,11 +51,9 @@
    "outputs": [],
    "source": [
     "# Load the CopernicusMarine data in the Agulhas region from the example_datasets\n",
-    "example_dataset_folder = parcels.download_example_dataset(\n",
-    "    \"CopernicusMarine_data_for_Argo_tutorial\"\n",
+    "ds_fields = parcels.tutorial.open_dataset(\n",
+    "    \"CopernicusMarine_data_for_Argo_tutorial/data\"\n",
     ")\n",
-    "\n",
-    "ds_fields = xr.open_mfdataset(f\"{example_dataset_folder}/*.nc\", combine=\"by_coords\")\n",
     "ds_fields.load()  # load the dataset into memory\n",
     "\n",
     "# Convert to SGRID-compliant dataset and create FieldSet\n",

docs/user_guide/examples/tutorial_diffusion.ipynb

@@ -119,7 +119,8 @@
     "import trajan as ta\n",
     "import xarray as xr\n",
     "\n",
-    "import parcels"
+    "import parcels\n",
+    "import parcels.tutorial"
    ]
   },
   {
@@ -467,12 +468,8 @@
    "outputs": [],
    "source": [
     "# Load the CopernicusMarine data in the Agulhas region from the example_datasets\n",
-    "example_dataset_folder = parcels.download_example_dataset(\n",
-    "    \"CopernicusMarine_data_for_Argo_tutorial\"\n",
-    ")\n",
-    "\n",
-    "ds_fields = xr.open_mfdataset(\n",
-    "    f\"{example_dataset_folder}/*.nc\", combine=\"by_coords\"\n",
+    "ds_fields = parcels.tutorial.open_dataset(\n",
+    "    \"CopernicusMarine_data_for_Argo_tutorial/data\"\n",
     ").isel(depth=slice(0, 1))\n",
     "ds_fields.load()  # load the dataset into memory"
    ]

docs/user_guide/examples/tutorial_dt_integrators.ipynb

@@ -59,13 +59,12 @@
     "import xarray as xr\n",
     "\n",
     "import parcels\n",
+    "import parcels.tutorial\n",
     "\n",
     "# Load the CopernicusMarine data in the Agulhas region from the example_datasets\n",
-    "example_dataset_folder = parcels.download_example_dataset(\n",
-    "    \"CopernicusMarine_data_for_Argo_tutorial\"\n",
+    "ds_fields = parcels.tutorial.open_dataset(\n",
+    "    \"CopernicusMarine_data_for_Argo_tutorial/data\"\n",
     ")\n",
-    "\n",
-    "ds_fields = xr.open_mfdataset(f\"{example_dataset_folder}/*.nc\", combine=\"by_coords\")\n",
     "ds_fields.load()  # load the dataset into memory\n",
     "\n",
     "# Convert to SGRID-compliant dataset and create FieldSet\n",

docs/user_guide/examples/tutorial_gsw_density.ipynb

@@ -36,14 +36,13 @@
     "import xarray as xr\n",
     "\n",
     "import parcels\n",
+    "import parcels.tutorial\n",
     "\n",
     "# Load the CopernicusMarine data in the Agulhas region from the example_datasets\n",
-    "example_dataset_folder = parcels.download_example_dataset(\n",
-    "    \"CopernicusMarine_data_for_Argo_tutorial\"\n",
+    "ds_fields = parcels.tutorial.open_dataset(\n",
+    "    \"CopernicusMarine_data_for_Argo_tutorial/data\"\n",
     ")\n",
     "\n",
-    "ds_fields = xr.open_mfdataset(f\"{example_dataset_folder}/*.nc\", combine=\"by_coords\")\n",
-    "\n",
     "# TODO check how we can get good performance without loading full dataset in memory\n",
     "ds_fields.load()  # load the dataset into memory\n",
     "\n",