Skip to content
Merged
Show file tree
Hide file tree
Changes from 14 commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion docs/conf.py
Original file line number Diff line number Diff line change
Expand Up @@ -533,7 +533,7 @@ def linkcode_resolve(domain, info):

# -- Options for autoapi --------------------------------------------------
autoapi_dirs = ["../src/parcels"]
# autoapi_add_toctree_entry = False
autoapi_add_toctree_entry = False
autoapi_root = "reference"
autoapi_options = [
"members",
Expand Down
2 changes: 1 addition & 1 deletion docs/development/policies.md
Original file line number Diff line number Diff line change
Expand Up @@ -10,7 +10,7 @@ We accept that Parcels developers have their own motivation for using (or not us

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.

The [CLAUDE.md](/CLAUDE.md) file in the repository has additional instructions for AI agents to follow when contributing to Parcels.
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.

## Versioning

Expand Down
4 changes: 2 additions & 2 deletions docs/getting_started/explanation_concepts.md
Original file line number Diff line number Diff line change
Expand Up @@ -17,7 +17,7 @@ A Parcels simulation is generally built up from four different components:
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).
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.

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.
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.

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

```{admonition} 🖥️ Learn how to run a simulation
:class: seealso
- [Choose an appropriate timestep and integrator](../user_guide/examples/tutorial_numerical_accuracy.ipynb)
- [Choose an appropriate timestep and integrator](../user_guide/examples/tutorial_dt_integrators.ipynb)
- [Work with Parcels output](./tutorial_output.ipynb)
```
2 changes: 1 addition & 1 deletion docs/getting_started/installation.md
Original file line number Diff line number Diff line change
Expand Up @@ -33,7 +33,7 @@ conda activate parcels
The next time you start a terminal and want to work with Parcels, activate the environment with `conda activate parcels`.
```

**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.
**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.

## Installation for developers

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

## Imports

Expand Down
Loading
Loading