add a recipes section to doc (#58)

EcoExtreML · Sep 2, 2024 · efb443a · efb443a
1 parent 67d2ea9
commit efb443a
Show file tree

Hide file tree

Showing 2 changed files with 13 additions and 0 deletions.
diff --git a/docs/available_recipes.md b/docs/available_recipes.md
@@ -0,0 +1,12 @@
+A recipe is a set of instructions for downloading and processing the input data
+(see [available
+datasets](https://zampy.readthedocs.io/en/latest/available_datasets/)). Recipes
+are used to create pre-processing steps in a consistent and transparent way.
+Recipe format is usullay ``.yml`` and is stored in the [recipes
+folder](https://github.com/EcoExtreML/zampy/tree/main/recipes). To know how to
+run a recipe, see [Getting started](https://zampy.readthedocs.io/en/latest/).
+The following recipes are available:
+
+- `STEMMUS_SCOPE_input.yml`: this recipe can be used to download and prepare
+  some of the input data required by [STEMMUS_SCOPE
+  model](https://github.com/EcoExtreML/STEMMUS_SCOPE).
diff --git a/mkdocs.yml b/mkdocs.yml
@@ -6,6 +6,7 @@ nav:
   - Getting started: index.md
   - Configuration: configuration.md
   - Available datasets: available_datasets.md
+  - Available recipes: available_recipes.md
   - For developers : README.dev.md
   - Contributing : CONTRIBUTING.md