|
2 | 2 |
|
3 | 3 | Shown below are several documentation and tutorial Jupyter notebooks and scripts which go through various aspects of Parcels. |
4 | 4 |
|
| 5 | +```{note} |
| 6 | +The tutorials written for Parcels v3 are currently being updated for Parcels v4. Shown below are only the notebooks which have been updated. |
| 7 | +[Feel free to post a Discussion on GitHub](https://github.com/OceanParcels/Parcels/discussions/categories/ideas) if you feel like v4 needs a specific tutorial that wasn't in v3, or [post an issue](https://github.com/OceanParcels/Parcels/issues/new?template=01_feature.md) if you feel that the notebooks below can be improved! |
| 8 | +``` |
| 9 | + |
5 | 10 | ```{nbgallery} |
6 | 11 | :caption: Overview |
7 | 12 | :name: tutorial-overview |
8 | 13 |
|
9 | | -../examples/tutorial_parcels_structure.ipynb |
10 | | -../examples/parcels_tutorial.ipynb |
11 | | -../examples/tutorial_output.ipynb |
| 14 | +<!-- ../examples/tutorial_parcels_structure.ipynb --> |
| 15 | +<!-- ../examples/parcels_tutorial.ipynb --> |
| 16 | +<!-- ../examples/tutorial_output.ipynb --> |
12 | 17 | ``` |
13 | 18 |
|
14 | 19 | ```{nbgallery} |
15 | 20 | :caption: Setting up FieldSets |
16 | 21 | :name: tutorial-fieldsets |
17 | 22 |
|
18 | | -../examples/documentation_indexing.ipynb |
19 | | -../examples/tutorial_nemo_curvilinear.ipynb |
20 | | -../examples/tutorial_nemo_3D.ipynb |
21 | | -../examples/tutorial_croco_3D.ipynb |
22 | | -../examples/tutorial_timevaryingdepthdimensions.ipynb |
23 | | -../examples/tutorial_periodic_boundaries.ipynb |
24 | | -../examples/tutorial_interpolation.ipynb |
25 | | -../examples/tutorial_unitconverters.ipynb |
| 23 | +<!-- ../examples/documentation_indexing.ipynb --> |
| 24 | +<!-- ../examples/tutorial_nemo_curvilinear.ipynb --> |
| 25 | +<!-- ../examples/tutorial_nemo_3D.ipynb --> |
| 26 | +<!-- ../examples/tutorial_croco_3D.ipynb --> |
| 27 | +<!-- ../examples/tutorial_timevaryingdepthdimensions.ipynb --> |
| 28 | +<!-- ../examples/tutorial_periodic_boundaries.ipynb --> |
| 29 | +<!-- ../examples/tutorial_interpolation.ipynb --> |
| 30 | +<!-- ../examples/tutorial_unitconverters.ipynb --> |
26 | 31 | ``` |
27 | 32 |
|
28 | 33 | ```{nbgallery} |
29 | 34 | :caption: Creating ParticleSets |
30 | 35 | :name: tutorial-particlesets |
31 | 36 |
|
32 | | -../examples/tutorial_delaystart.ipynb |
| 37 | +<!-- ../examples/tutorial_delaystart.ipynb --> |
33 | 38 | ``` |
34 | 39 |
|
35 | 40 | ```{nbgallery} |
36 | 41 | :caption: Writing kernels to be executed on each particle |
37 | 42 | :name: tutorial-kernels |
38 | 43 |
|
39 | | -../examples/tutorial_diffusion.ipynb |
40 | | -../examples/tutorial_sampling.ipynb |
41 | | -../examples/tutorial_particle_field_interaction.ipynb |
42 | | -../examples/tutorial_interaction.ipynb |
43 | | -../examples/tutorial_analyticaladvection.ipynb |
44 | | -../examples/tutorial_kernelloop.ipynb |
| 44 | +<!-- ../examples/tutorial_diffusion.ipynb --> |
| 45 | +<!-- ../examples/tutorial_sampling.ipynb --> |
| 46 | +<!-- ../examples/tutorial_particle_field_interaction.ipynb --> |
| 47 | +<!-- ../examples/tutorial_interaction.ipynb --> |
| 48 | +<!-- ../examples/tutorial_analyticaladvection.ipynb --> |
| 49 | +<!-- ../examples/tutorial_kernelloop.ipynb --> |
45 | 50 | ``` |
46 | 51 |
|
47 | 52 | ```{nbgallery} |
48 | 53 | :caption: Other tutorials |
49 | 54 | :name: tutorial-other |
50 | 55 |
|
51 | | -../examples/tutorial_peninsula_AvsCgrid.ipynb |
52 | | -../examples/documentation_MPI.ipynb |
53 | | -../examples/documentation_stuck_particles.ipynb |
54 | | -../examples/documentation_unstuck_Agrid.ipynb |
55 | | -../examples/documentation_LargeRunsOutput.ipynb |
56 | | -../examples/documentation_geospatial.ipynb |
57 | | -../examples/documentation_advanced_zarr.ipynb |
| 56 | +<!-- ../examples/tutorial_peninsula_AvsCgrid.ipynb --> |
| 57 | +<!-- ../examples/documentation_MPI.ipynb --> |
| 58 | +<!-- ../examples/documentation_stuck_particles.ipynb --> |
| 59 | +<!-- ../examples/documentation_unstuck_Agrid.ipynb --> |
| 60 | +<!-- ../examples/documentation_LargeRunsOutput.ipynb --> |
| 61 | +<!-- ../examples/documentation_geospatial.ipynb --> |
| 62 | +<!-- ../examples/documentation_advanced_zarr.ipynb --> |
58 | 63 | ``` |
59 | 64 |
|
60 | 65 | ```{nbgallery} |
61 | 66 | :caption: Worked examples |
62 | 67 | :name: tutorial-examples |
63 | 68 |
|
64 | 69 | ../examples/tutorial_Argofloats.ipynb |
65 | | -../examples/documentation_homepage_animation.ipynb |
| 70 | +<!-- ../examples/documentation_homepage_animation.ipynb --> |
66 | 71 | ``` |
67 | 72 |
|
68 | 73 | ## Python Example Scripts |
|
0 commit comments