Skip to content

Commit f915d4d

Browse files
reint-fischerreint-fischer
authored andcommitted
scaffold explanations
1 parent 620b42f commit f915d4d

22 files changed

Lines changed: 33 additions & 2 deletions

docs/getting_started/explanation_concepts.md

Lines changed: 33 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -5,6 +5,37 @@ kernelspec:
55
---
66
# Parcels concepts
77

8-
The flexibility of Parcels enables a wide range of applications and the building of complex simulations. In order to help structure your code, this tutorial describes the structure that a Parcels script uses.
8+
Parcels is a set of Python classes and methods to create particle tracking simulations. Here, we will explain the basic concepts defined by the most important classes and functions. This overview can be useful to start understanding the names for different components we use in Parcels, and to structure and make appropriate use of the code in a simulation script.
99

10-
Code that uses Parcels is generally built up from four different components:
10+
A Parcels simulation is generally built up from four different components:
11+
1. [**FieldSet**](#1.-FieldSet). The input dataset of gridded fields (e.g. ocean current velocity, temperature) in which virtual particles are defined.
12+
2. [**ParticleSet**](#2.-ParticleSet). The dataset of virtual particles. These always contain time, z, lat, and lon, for which initial values must be defined, and may contain other variables.
13+
3. [**Kernels**](#3.-Kernels). Kernels perform some specific operation on the particles every time step (e.g. interpolate the temperature from the temperature field to the particle location).
14+
4. [**Execute**](#4.-Execution). Execute the simulation. The core method which integrates the operations defined in Kernels for a given time and timestep, and writes output to a ParticleFile.
15+
16+
We discuss each component in more detail below and link to more detailed [how-to guides](../user_guide/index.md) and the full list of classes and methods in the [API reference](../reference.md). If you want to learn by doing, check out the [quickstart tutorial](./tutorial_quickstart.md) to start creating your first Parcels simulation.
17+
18+
![png](images/parcels_user_diagram.png)
19+
20+
## 1. FieldSet
21+
22+
Parcels provides a framework to simulate particles **within a set of fields**, such as flow velocities and temperature. To start a parcels simulation we must define this dataset with the `FieldSet` class.
23+
24+
The input dataset from which to create a `FieldSet` can be an `xarray.Dataset` with output from a hydrodynamic model or reanalysis.
25+
26+
### Grid
27+
read more about [grids](../user_guide/explanations/explanation_grids.md)
28+
29+
### Interpolation
30+
read more about [interpolation](../user_guide/explanations/explanation_interpolation.md)
31+
32+
## 2. ParticleSet
33+
34+
35+
## 3. Kernels
36+
read more about [Kernels](../user_guide/explanations/explanation_kernelloop.md)
37+
38+
## 4. Execution
39+
40+
### Output
41+
ParticleFile

docs/user_guide/explanations/explanation_grids.md

Whitespace-only changes.

docs/user_guide/examples/explanation_interpolation.md renamed to docs/user_guide/explanations/explanation_interpolation.md

File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.

docs/user_guide/examples/images/ParcelsParallel.png renamed to docs/user_guide/how-to-guides/images/ParcelsParallel.png

File renamed without changes.

docs/user_guide/examples/images/grid_comparison.png renamed to docs/user_guide/how-to-guides/images/grid_comparison.png

File renamed without changes.
File renamed without changes.

docs/user_guide/examples/images/parcels_user_diagram.png renamed to docs/user_guide/how-to-guides/images/parcels_user_diagram.png

File renamed without changes.

0 commit comments

Comments
 (0)