Skip to content

Commit

Permalink
Also add some information on the excercises to README
Browse files Browse the repository at this point in the history
  • Loading branch information
JoerivanEngelen committed Mar 14, 2024
1 parent f5618dd commit 6dbac0a
Showing 1 changed file with 10 additions and 1 deletion.
11 changes: 10 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
# Demo project FAIR-data
This is a dummy project to demonstrate the Deltares [FAIR-data Cookbook](https://publicwiki.deltares.nl/display/FAIR/Checklist+Reproducible+Numerical+Modelling). Note that it is a dummy project. So no realistic calculations are performed. More information about the FAIR cookbook is available at the Deltares wiki. This dummy project is meant to get a basic understanding and working knowledge of version control for scripts and data, workflow management and sensible folder structure. For this we use GIT, DVC, Snakemake and Cookiecutter. More information and instructions can be found in [Deltares documentation](https://deltares.github.io/iMOD-Documentation\practical_git_dvc.html) and other online sources, but for the practical example the instructions below will suffice.
This is a dummy project to demonstrate the Deltares [FAIR-data Cookbook](https://publicwiki.deltares.nl/display/FAIR/Checklist+Reproducible+Numerical+Modelling). Note that it is a dummy project, so no realistic calculations are performed. [More information about the FAIR cookbook is available at the Deltares wiki](https://publicwiki.deltares.nl/display/FAIR/Checklist+Reproducible+Numerical+Modelling). This dummy project is meant to get a basic understanding and working knowledge of version control for scripts and data, workflow management and sensible folder structure. For this we use GIT, DVC, Snakemake and Cookiecutter. More information and instructions can be found in [Deltares documentation](https://deltares.github.io/iMOD-Documentation\practical_git_dvc.html) and other online sources, but for the practical example the instructions below will suffice.


## Version control and retrieving the repository
Expand Down Expand Up @@ -84,3 +84,12 @@ Cookiecutter is used to create a standardized template for a folder structure fo
## Explanation of the project
In this dummy project some very basic calculations are done using the SWAN wave model. For a more detailed explanation, read [TECHNICAL.md](/TECHNICAL.md).

# Pizza course exercises
This pizza course consists of two exercises. This repository contains the first
exercise, where you will reproduce an existing example project. [You can find
the first excercise here.](/EXERCISE.md)

The second exercise is contained in a different Github repository. This exercise
will walk you through the steps to upgrade your project from a set of scripts to
a fully reproducible workflow. [You can find it
here](https://github.com/Deltares-research/FAIR-data-reproducible-project-from-scratch).

0 comments on commit 6dbac0a

Please sign in to comment.