Update README
-
Clone only the main branch for end-users git clone --depth=1 --branch=master git@codebase.helmholtz.cloud:awi_paleodyn/growth-model-atlantic-cod.git
-
regarding LFS (are the data not downloaded correctly? -- could you elaborate on this?) Please refactor/remove this part
Because of the LFS label the .netcdf files in the input_data might not be downloaded by git. Please, check if the input files were downloaded correctly: ~~~ $ cd ./input_data/ $ ncdump -h <file name>.nc ~~~ If the download via cloning didn't work, you need to download the input_data manually from the repository and replase the content of the cloned input_data folder with it.
-
Rephrase: "in the root path of the project run poetry install
"Rest bash commands can be neglected.
- Build the package with `poetry` ~~~ $ cd growth-model-atlantic-cod $ poetry build -f wheel $ poetry install ~~~
-
Add this point to download the submodule git submodule update --init --recursive
-
Add a section $ poetry build -f wheel
to explain how to install it in any other python env. -
Add poetry run cod-growth-model ./config/base.toml ./output/base_model.csv
as an alternative for the example? -
Change Auther name Foerster
toFörster
-
[ ] for a good preview of the web page use live-server https://www.npmjs.com/package/live-server