Skip to content

Commit 79e41df

Browse files
reint-fischerreint-fischer
authored andcommitted
start writing quickstart tutorial
1 parent bba37f4 commit 79e41df

File tree

3 files changed

+8
-5
lines changed

3 files changed

+8
-5
lines changed

docs/development/docsguide.md

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -17,4 +17,6 @@ TODO: outline functions of the documentation based on resources
1717

1818
## Style guide
1919

20-
- Write documentation in first person plural ("we"). In our open source code, tutorials and guides can be written by any developer or user, so the documentation teaches all of us how to do something with Parcels.
20+
- **Write out `parcels.class.method` in tutorials and how-to guides** so that we can see which classes and methods are part of Parcels. If we use `from parcels import class`, the use of `class` in a cell further along is not obviously part of `parcels`.
21+
- **Import packages at the top of the section in which they are first used** to show what they are used for.
22+
- **Write documentation in first person plural ("we").** In our open source code, tutorials and guides can be written by any developer or user, so the documentation teaches all of us how to do something with Parcels. Sometimes it can be more natural to take on the tone of a teacher, writing to a student/learner, in which case it is okay to use "you". Please refrain from using impersonal subjects such as "the user".
Lines changed: 5 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,6 @@
1-
# Quickstart tutorial"
1+
# Quickstart tutorial
2+
```{note}
3+
TODO: Completely rewrite examples/parcels_tutorial.ipynb to be this quickstart tutorial. Decide which file format and notebook testing to do so this file is checked, which is not in the "examples" folder
4+
```
25

3-
TODO: Completely rewrite examples/parcels_tutorial.ipynb into the quickstart tutorial. Decide which file format and notebook testing to do so this file is checked, which is not in the "examples" folder
6+
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, or how they relate to each other, we have a [concepts overview](concepts_overview.md) to describe how we think about them. Let's dive in!

docs/index.md

Lines changed: 0 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -8,8 +8,6 @@ Welcome to the documentation of Parcels. **Parcels** provides a set of Python cl
88

99
_Animation of virtual particles carried by ocean surface flow in the global oceans. The particles are advected with Parcels in data from the_ [NEMO Ocean Model](https://www.nemo-ocean.eu/).
1010

11-
**Version**: {{env.config.version}}
12-
1311
```{note}
1412
You can browse the documentation for older versions by using the version switcher in the bottom right.
1513
```

0 commit comments

Comments
 (0)