diff --git a/README.md b/README.md index 85b954503d2c36c1918ec0e85a62bd2efab27de2..35c8a29b8192c23fddbf387815112710e4da2ec2 100644 --- a/README.md +++ b/README.md @@ -20,22 +20,27 @@ TBD, see pyproject.toml # Installation Move to the folder you want to create download this project to. +We now need to download the source code (https://gitlab.jsc.fz-juelich.de/esde/toar-public/toargridding/-/tree/dev?ref_type=heads). Either as ZIP folder or via git: -Clone the project from its git repository +Clone the project from its git repository: ``` git clone https://gitlab.jsc.fz-juelich.de/esde/toar-public/toargridding.git ``` - -The handling of required packages is done with poetry. -For installing them go to the new created directory and run poetry +With git we need to checkout the development branch. Therefore we need to change to the project directory first: ``` cd toargridding +git checkout dev +``` + + +The handling of required packages is done with poetry. So run poetry in the project directory: +``` poetry install ``` # Example -There are at the moment three example provided as jupyter notebooks: +There are at the moment three example provided as jupyter notebooks (https://jupyter.org/): ## High level function ``` tests/produce_data.ipynb