Skip to content

Commit 8b64522

Browse files
reint-fischerreint-fischer
authored andcommitted
add emojis and change links from subsection to admonitions
1 parent 590bbe4 commit 8b64522

File tree

3 files changed

+23
-16
lines changed

3 files changed

+23
-16
lines changed

docs/getting_started/explanation_concepts.md

Lines changed: 21 additions & 14 deletions
Original file line numberDiff line numberDiff line change
@@ -55,21 +55,24 @@ fieldset = parcels.FieldSet([Ucurrent, Ustokes])
5555

5656
Each `parcels.Field` is defined on a grid. With Parcels, we can simulate particles in fields on both structured (**`parcels.XGrid`**) and unstructured (**`parcels.UxGrid`**) grids. The grid is defined by the coordinates of grid cell nodes, edges, and faces. `parcels.XGrid` objects are based on [`xgcm.Grid`](https://xgcm.readthedocs.io/en/latest/grids.html), while `parcels.UxGrid` objects are based on [`uxarray.Grid`](https://uxarray.readthedocs.io/en/stable/generated/uxarray.Grid.html#uxarray.Grid) objects.
5757

58-
#### Read more about grids
59-
58+
```{admonition} 📖 Read more about grids
59+
:class: seealso
6060
- [Grids explanation](../user_guide/examples/explanation_grids.md)
61+
```
6162

6263
### Interpolation
6364

6465
To find the value of a `parcels.Field` at any particle location, Parcels interpolates the gridded field. Depending on the variable, grid, and required accuracy, different interpolation methods may be appropriate. Parcels comes with a number of built-in **`parcels.interpolators`**.
6566

66-
#### Read more about interpolation
67-
67+
```{admonition} 📖 Read more about interpolation
68+
:class: seealso
6869
- [Interpolation explanation](../user_guide/examples/explanation_interpolation.md)
70+
```
6971

70-
#### Learn how to use Parcels interpolators
71-
72+
```{admonition} 🖥️ Learn how to use Parcels interpolators
73+
:class: seealso
7274
- [Interpolators guide](../user_guide/examples/tutorial_interpolation.ipynb)
75+
```
7376

7477
## 2. ParticleSet
7578

@@ -89,9 +92,10 @@ lon = np.array([0])
8992
pset = parcels.ParticleSet(fieldset=fieldset, pclass=parcels.Particle, time=time, z=z, lat=lat, lon=lon)
9093
```
9194

92-
### Learn more about how to create ParticleSets
93-
95+
```{admonition} 🖥️ Learn more about how to create ParticleSets
96+
:class: seealso
9497
- [Release particles at different times](../user_guide/examples/tutorial_delaystart.ipynb)
98+
```
9599

96100
## 3. Kernels
97101

@@ -148,16 +152,18 @@ Every Kernel must be a function with the following (and only those) arguments: `
148152
We have to be careful with writing kernels for vector fields on Curvilinear grids. While Parcels automatically rotates the "U" and "V" field when necessary, this is not the case for other fields such as Stokes drift. [This guide](../user_guide/examples/tutorial_nemo_curvilinear.ipynb) describes how to use a curvilinear grid in Parcels.
149153
```
150154

151-
### Read more about the Kernel loop
152-
155+
```{admonition} 📖 Read more about the Kernel loop
156+
:class: seealso
153157
- [The Kernel loop](../user_guide/examples/explanation_kernelloop.md)
158+
```
154159

155-
### Learn how to write kernels
156-
160+
```{admonition} 🖥️ Learn how to write kernels
161+
:class: seealso
157162
- [Sample fields like temperature](../user_guide/examples/tutorial_sampling.ipynb).
158163
- [Mimic the behaviour of ARGO floats](../user_guide/examples/tutorial_Argofloats.ipynb).
159164
- [Add diffusion to approximate subgrid-scale processes and unresolved physics](../user_guide/examples/tutorial_diffusion.ipynb).
160165
- [Convert between units in m/s and degrees](../user_guide/examples/tutorial_unitconverters.ipynb).
166+
```
161167

162168
## 4. Execute
163169

@@ -182,7 +188,8 @@ To analyse the particle data generated in the simulation, we need to define a `p
182188

183189
There are many ways to analyze particle output, and although we provide [a short tutorial to get started](./tutorial_output.ipynb), we recommend writing your own analysis code and checking out other projects such as [trajan](https://opendrift.github.io/trajan/index.html) and [Lagrangian Diagnostics](https://lagrangian-diags.readthedocs.io/en/latest/).
184190

185-
#### Learn how to run a simulation
186-
191+
```{admonition} 🖥️ Learn how to run a simulation
192+
:class: seealso
187193
- [Choose an appropriate timestep and integrator](../user_guide/examples/tutorial_numerical_accuracy.ipynb)
188194
- [Work with Parcels output](./tutorial_output.ipynb)
195+
```

docs/getting_started/index.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,7 @@ Getting started with parcels is easy; here you will find:
44

55
```{toctree}
66
:maxdepth: 1
7-
Installation guide <installation.md>
7+
📦 Installation guide <installation.md>
88
🎓 Quickstart tutorial <tutorial_quickstart.md>
99
🎓 Output tutorial <tutorial_output.ipynb>
1010
📖 Conceptual workflow <explanation_concepts.md>

docs/getting_started/installation.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
# Installation guide
1+
# 📦 Installation guide
22

33
## Basic Installation
44

0 commit comments

Comments
 (0)