Skip to content
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.

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

Updating documentation notebooks #1237

Merged
merged 2 commits into from
Sep 19, 2022
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
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
7 changes: 7 additions & 0 deletions parcels/examples/documentation_MPI.ipynb
Original file line number Diff line number Diff line change
Expand Up @@ -7,6 +7,13 @@
"## Tutorial on Parallel Parcels with MPI and `dask` field-chunking"
]
},
{
"cell_type": "markdown",
"metadata": {},
"source": [
"<center><i> NOTE THAT THIS DOCUMENTATION NOTEBOOK CAN'T BE RUN WITH THE EXAMPLE-OUTPUT THAT SHIPS WITH PARCELS. THESE DOCUMENTATION NOTEBOOKS ARE FOR BACKGROUND INFO ONLY <i></center>"
]
},
{
"cell_type": "markdown",
"metadata": {},
Expand Down
7 changes: 7 additions & 0 deletions parcels/examples/documentation_homepage_animation.ipynb
Original file line number Diff line number Diff line change
@@ -1,5 +1,12 @@
{
"cells": [
{
"cell_type": "markdown",
"metadata": {},
"source": [
"<center><i> NOTE THAT THIS DOCUMENTATION NOTEBOOK CAN'T BE RUN WITH THE EXAMPLE-OUTPUT THAT SHIPS WITH PARCELS. THESE DOCUMENTATION NOTEBOOKS ARE FOR BACKGROUND INFO ONLY <i></center>"
]
},
{
"cell_type": "code",
"execution_count": 1,
Expand Down
7 changes: 7 additions & 0 deletions parcels/examples/documentation_indexing.ipynb
Original file line number Diff line number Diff line change
Expand Up @@ -7,6 +7,13 @@
"## Documentation on dimensions and indexing in Parcels"
]
},
{
"cell_type": "markdown",
"metadata": {},
"source": [
"<center><i> NOTE THAT THIS DOCUMENTATION NOTEBOOK CAN'T BE RUN WITH THE EXAMPLE-OUTPUT THAT SHIPS WITH PARCELS. THESE DOCUMENTATION NOTEBOOKS ARE FOR BACKGROUND INFO ONLY <i></center>"
]
},
{
"cell_type": "markdown",
"metadata": {},
Expand Down
23 changes: 22 additions & 1 deletion parcels/examples/documentation_stuck_particles.ipynb
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,28 @@
}
},
"source": [
"# Documentation of particles 'stuck' on boundaries\n",
"# Documentation of particles 'stuck' on boundaries"
]
},
{
"cell_type": "markdown",
"metadata": {
"slideshow": {
"slide_type": "slide"
}
},
"source": [
"<center><i> NOTE THAT THIS DOCUMENTATION NOTEBOOK CAN'T BE RUN WITH THE EXAMPLE-OUTPUT THAT SHIPS WITH PARCELS. THESE DOCUMENTATION NOTEBOOKS ARE FOR BACKGROUND INFO ONLY <i></center>"
]
},
{
"cell_type": "markdown",
"metadata": {
"slideshow": {
"slide_type": "slide"
}
},
"source": [
"In some Parcels simulations, particles end up moving onto parts of the grid where the velocity field is not defined, such as for example onto land. In this tutorial we look at how this depends on the grid structure. \n",
"\n",
"**Short conclusion: Particles can get stuck on Arakawa A grids and B grids but should not get stuck on C grids.**\n",
Expand Down
7 changes: 7 additions & 0 deletions parcels/examples/documentation_unstuck_Agrid.ipynb
Original file line number Diff line number Diff line change
Expand Up @@ -7,6 +7,13 @@
"# Tutorial on implementing boundary conditions in an A grid"
]
},
{
"cell_type": "markdown",
"metadata": {},
"source": [
"<center><i> NOTE THAT THIS DOCUMENTATION NOTEBOOK CAN'T BE RUN WITH THE EXAMPLE-OUTPUT THAT SHIPS WITH PARCELS. THESE DOCUMENTATION NOTEBOOKS ARE FOR BACKGROUND INFO ONLY <i></center>"
]
},
{
"cell_type": "markdown",
"metadata": {},
Expand Down
2 changes: 1 addition & 1 deletion parcels/examples/tutorial_diffusion.ipynb
Original file line number Diff line number Diff line change
Expand Up @@ -17,7 +17,7 @@
" \\mathbf{X}(t_0) &= \\mathbf{x}_0,\n",
"\\end{aligned}\n",
"$$\n",
"where $\\mathbf{X}$ is the particle position vector ($\\mathbf{x}_0$ being the initial position vector), $\\mathbf{u}$ the velocity vector, $\\mathbf{K} = \\frac{1}{2} \\mathbf{V} \\cdot \\mathbf{V}^T$ the diffusivity tensor, and $d\\mathbf{W}(t)$ a Wiener increment (normally distributed with zero mean and variance $dt$). Particle distributions obtained by solving the above equation are therefore consistent with Eulerian concentrations found by solving the advection-diffusion equation. \n",
"where $\\mathbf{X}$ is the particle position vector ($\\mathbf{x}_0$ being the initial position vector), and $\\mathbf{u}$ the velocity vector. $\\mathbf{V}$ is calculated from the diffusivity tensor $\\mathbf{K} = \\frac{1}{2} \\mathbf{V} \\cdot \\mathbf{V}^T$ and $d\\mathbf{W}(t)$ a Wiener increment (normally distributed with zero mean and variance $dt$). Particle distributions obtained by solving the above equation are therefore consistent with Eulerian concentrations found by solving the advection-diffusion equation. \n",
"\n",
"In three-dimensional ocean models diffusion operates along slopes of neutral buoyancy. To account for these slopes, the 3D diffusivity tensor $\\mathbf{K}$ (and therefore $\\mathbf{V}$) contains off-diagonal components. Three-dimensional advection-diffusion is not yet implemented in _Parcels_, but it is currently under development. Here we instead focus on the simpler case of diffusion in a horizontal plane, where diffusivity is specified only in the zonal and meridional direction, i.e. \n",
"$$\\mathbf{K}(x,y)=\\begin{bmatrix}\n",
Expand Down