Skip to content

[DOCS] Further cleaning up of the documentation #2755

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

Draft
erikvansebille wants to merge 2 commits into
base: main
Choose a base branch
from
+21 −6
Draft

[DOCS] Further cleaning up of the documentation #2755

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
c4f81a6
Simplify title of interpolation tutorial
erikvansebille Jul 16, 2026
1e2bff8
Update Nemo tutorial periodic boundaries
erikvansebille Jul 17, 2026
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
2 changes: 1 addition & 1 deletion docs/user_guide/examples/tutorial_interpolation.ipynb
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@
"cell_type": "markdown",
"metadata": {},
"source": [
"# 🖥️ Using the built-in `parcels.interpolators`\n",
"# 🖥️ Using the built-in Interpolators\n",
"Parcels comes with a number of different interpolation methods for fields on structured (`X`) and unstructured (`Ux`) grids. Here, we will look at a few common {py:obj}`parcels.interpolators` for tracer fields, and how to configure them in an idealised example. For more guidance on the sampling of such fields, check out the [sampling tutorial](./tutorial_sampling)."
]
},
Expand Down
25 changes: 20 additions & 5 deletions docs/user_guide/examples/tutorial_nemo.ipynb
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -155,7 +155,7 @@
")\n",
"\n",
"pset.execute(\n",
" [parcels.kernels.AdvectionEE],\n",
" parcels.kernels.AdvectionRK2,\n",
" runtime=runtime,\n",
" dt=np.timedelta64(1, \"D\"),\n",
" output_file=pfile,\n",
Expand Down Expand Up @@ -203,7 +203,7 @@
"metadata": {},
"outputs": [],
"source": [
"# post processing\n",
"# handling periodic boundary conditions in post processing\n",
"df = df.with_columns((pl.col(\"x\") % 360).alias(\"x\"))\n",
"df = df.with_columns(\n",
" pl.when(pl.col(\"x\") <= 180)\n",
Expand All @@ -223,8 +223,23 @@
},
"outputs": [],
"source": [
"# with a Kernel\n",
"def periodicBC(particles, fieldset): # pragma: no cover\n",
"# with a custom Kernel\n",
"def AdvectionRK2_periodicBC(particles, fieldset): # pragma: no cover\n",
" \"\"\"Advection of particles using second-order Runge-Kutta integration,\n",
" keeping particles between -180 and 180 degrees longitude.\n",
" \"\"\"\n",
" (u1, v1) = fieldset.UV[particles]\n",
" x1 = particles.x + u1 * 0.5 * particles.dt\n",
" y1 = particles.y + v1 * 0.5 * particles.dt\n",
" x1 = np.where(x1 > 180, x1 - 360, x1) # keep particles within [-180, 180]\n",
"\n",
" (u2, v2) = fieldset.UV[\n",
" particles.t + 0.5 * particles.dt, particles.z, y1, x1, particles\n",
" ]\n",
" particles.dx += u2 * particles.dt\n",
" particles.dy += v2 * particles.dt\n",
"\n",
" # update particles.dx to stay within [-180, 180]\n",
" particles.dx = np.where(\n",
" particles.x + particles.dx > 180, particles.dx - 360, particles.dx\n",
" )\n",
Expand All @@ -236,7 +251,7 @@
")\n",
"\n",
"pset.execute(\n",
" [parcels.kernels.AdvectionEE, periodicBC],\n",
" AdvectionRK2_periodicBC,\n",
" runtime=runtime,\n",
" dt=np.timedelta64(1, \"D\"),\n",
" output_file=pfile,\n",
Expand Down