Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Add a recipes section to doc #58

Merged
merged 1 commit into from
Sep 2, 2024
Merged

Add a recipes section to doc #58

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
12 changes: 12 additions & 0 deletions docs/available_recipes.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -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).
1 change: 1 addition & 0 deletions mkdocs.yml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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

Expand Down
Loading