Skip to content

Commit d4bbfc2

Browse files
Merge pull request #2438 from Parcels-code/how-to-accuracy
How to guide dt and integration scheme
2 parents 7425f84 + c978966 commit d4bbfc2

File tree

10 files changed

+875
-49
lines changed

10 files changed

+875
-49
lines changed

docs/conf.py

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -533,7 +533,7 @@ def linkcode_resolve(domain, info):
533533

534534
# -- Options for autoapi --------------------------------------------------
535535
autoapi_dirs = ["../src/parcels"]
536-
# autoapi_add_toctree_entry = False
536+
autoapi_add_toctree_entry = False
537537
autoapi_root = "reference"
538538
autoapi_options = [
539539
"members",

docs/development/policies.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -10,7 +10,7 @@ We accept that Parcels developers have their own motivation for using (or not us
1010
1111
Remember that reviews are done by human maintainers - asking us to review code that an AI wrote but you don't understand isn't kind to these maintainers.
1212

13-
The [CLAUDE.md](/CLAUDE.md) file in the repository has additional instructions for AI agents to follow when contributing to Parcels.
13+
The [CLAUDE.md](https://github.com/Parcels-code/Parcels/blob/HEAD/CLAUDE.md) file in the repository has additional instructions for AI agents to follow when contributing to Parcels.
1414

1515
## Versioning
1616

docs/getting_started/explanation_concepts.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -17,7 +17,7 @@ A Parcels simulation is generally built up from four different components:
1717
3. [**Kernels**](#3-kernels). Kernels perform some specific operation on the particles every time step (e.g. advect the particles with the three-dimensional flow; or interpolate the temperature field to the particle location).
1818
4. [**Execute**](#4-execute). Execute the simulation. The core method which integrates the operations defined in Kernels for a given runtime and timestep, and writes output to a ParticleFile.
1919

20-
We discuss each component in more detail below. The subsections titled **"Learn how to"** link to more detailed [how-to guide notebooks](../user_guide/index.md) and more detailed _explanations_ of Parcels functionality are included under **"Read more about"** subsections. The full list of classes and methods is 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.
20+
We discuss each component in more detail below. The subsections titled **"Learn how to"** link to more detailed [how-to guide notebooks](../user_guide/index.md) and more detailed _explanations_ of Parcels functionality are included under **"Read more about"** subsections. The full list of classes and methods is in the [API reference](../reference/parcels/index.rst). If you want to learn by doing, check out the [quickstart tutorial](./tutorial_quickstart.md) to start creating your first Parcels simulation.
2121

2222
```{figure} ../_static/concepts_diagram.png
2323
:alt: Parcels concepts diagram
@@ -190,6 +190,6 @@ There are many ways to analyze particle output, and although we provide [a short
190190

191191
```{admonition} 🖥️ Learn how to run a simulation
192192
:class: seealso
193-
- [Choose an appropriate timestep and integrator](../user_guide/examples/tutorial_numerical_accuracy.ipynb)
193+
- [Choose an appropriate timestep and integrator](../user_guide/examples/tutorial_dt_integrators.ipynb)
194194
- [Work with Parcels output](./tutorial_output.ipynb)
195195
```

docs/getting_started/installation.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -33,7 +33,7 @@ conda activate parcels
3333
The next time you start a terminal and want to work with Parcels, activate the environment with `conda activate parcels`.
3434
```
3535

36-
**Step 4:** Create a Jupyter Notebook or Python script to set up your first Parcels simulation! The [quickstart tutorial](tutorial_quickstart.md) is a great way to get started immediately. You can also first read about the core [Parcels concepts](concepts_overview.md) to familiarize yourself with the classes and methods you will use.
36+
**Step 4:** Create a Jupyter Notebook or Python script to set up your first Parcels simulation! The [quickstart tutorial](tutorial_quickstart.md) is a great way to get started immediately. You can also first read about the core [Parcels concepts](./explanation_concepts.md) to familiarize yourself with the classes and methods you will use.
3737

3838
## Installation for developers
3939

docs/getting_started/tutorial_quickstart.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -9,7 +9,7 @@ kernelspec:
99
Welcome to the **Parcels** quickstart tutorial, in which we will go through all the necessary steps to run a simulation.
1010
The code in this notebook can be used as a starting point to run Parcels in your own environment. Along the way we will
1111
familiarize ourselves with some specific classes and methods. If you are ever confused about one of these and want to
12-
read more, we have a [concepts overview](concepts_overview.md) discussing them in more detail. Let's dive in!
12+
read more, we have a [concepts overview](./explanation_concepts.md) discussing them in more detail. Let's dive in!
1313

1414
## Imports
1515

0 commit comments

Comments
 (0)