Skip to content

Commit 2d49457

Browse files
reint-fischerreint-fischer
authored andcommitted
start scaffolding getting_started and user_guide
1 parent 3b48b95 commit 2d49457

31 files changed

+69
-45
lines changed
Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1 @@
1+
A markdown document explaining the core Parcels classes

docs/getting_started/index.md

Lines changed: 12 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -5,7 +5,18 @@ Getting started with parcels is easy; here you will find:
55
```{toctree}
66
The installation guide <installation.md>
77
<!-- - a quickstart tutorial to running your first simulation <../examples_v3/parcels_tutorial.ipynb>
8-
- an overview of the important concepts <../examples_v3/tutorial_parcels_structure.ipynb>
8+
- an overview of the important concepts <concepts_overview.md>
99
- a simple tutorial on how to analyse the output from your first simulation <../examples_v3/tutorial_output.ipynb> -->
1010
1111
```
12+
```{note}
13+
TODO: Include one line conda installation for most common use
14+
```
15+
16+
```{note}
17+
TODO: Write quickstart tutorial. This should focus on getting users familiar with the different steps to take to run a simulation. Implicitly we should introduce them to the important concepts, but it should not be an in depth explanation. Instead we should reference to the concept overview and the reference API
18+
```
19+
20+
```{note}
21+
TODO: Rewrite parcels concepts overview. This .md file should contain most of what is currently in the tutorial_parcels_structure notebook.
22+
```

0 commit comments

Comments
 (0)