Skip to content

Commit 40d10cb

Browse files
committed
Comment out "out of date" notebooks and scripts from the documentation page
1 parent 7c1177a commit 40d10cb

File tree

1 file changed

+31
-26
lines changed

1 file changed

+31
-26
lines changed

docs/documentation/index.md

Lines changed: 31 additions & 26 deletions
Original file line numberDiff line numberDiff line change
@@ -2,67 +2,72 @@
22

33
Shown below are several documentation and tutorial Jupyter notebooks and scripts which go through various aspects of Parcels.
44

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+
510
```{nbgallery}
611
:caption: Overview
712
:name: tutorial-overview
813
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 -->
1217
```
1318

1419
```{nbgallery}
1520
:caption: Setting up FieldSets
1621
:name: tutorial-fieldsets
1722
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 -->
2631
```
2732

2833
```{nbgallery}
2934
:caption: Creating ParticleSets
3035
:name: tutorial-particlesets
3136
32-
../examples/tutorial_delaystart.ipynb
37+
<!-- ../examples/tutorial_delaystart.ipynb -->
3338
```
3439

3540
```{nbgallery}
3641
:caption: Writing kernels to be executed on each particle
3742
:name: tutorial-kernels
3843
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 -->
4550
```
4651

4752
```{nbgallery}
4853
:caption: Other tutorials
4954
:name: tutorial-other
5055
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 -->
5863
```
5964

6065
```{nbgallery}
6166
:caption: Worked examples
6267
:name: tutorial-examples
6368
6469
../examples/tutorial_Argofloats.ipynb
65-
../examples/documentation_homepage_animation.ipynb
70+
<!-- ../examples/documentation_homepage_animation.ipynb -->
6671
```
6772

6873
## Python Example Scripts

0 commit comments

Comments
 (0)