diff --git a/README.md b/README.md index d55e2ce2164fb0690523a95e59f8d85158dab8cd..2455c57a30fa1570f73fd628f0c6343a67ba444d 100644 --- a/README.md +++ b/README.md @@ -35,10 +35,20 @@ git checkout dev ## Installing Dependencies -The handling of required packages is done with poetry. So run poetry in the project directory: +The handling of required packages is done with poetry (https://python-poetry.org/). +After installing poetry, you can simply install all required dependencies for this project by runing poetry in the project directory: ``` poetry install ``` +This also leads to a creation of a virtual enviorment.Virtual enviorment are designed to ensure, that different projects do not interfere with their dependencies. +To run a script or a jupyter notebook in the virtual enviorment simply run +``` +poetry run jupyter notebook +``` +or +``` +poetry run python [/path/to/scriptname.py] +``` # How does this tool work? diff --git a/pyproject.toml b/pyproject.toml index 1decdb1fa46ab043beb7538bbbc544711b2fe236..4137448d1088f24370bf540263e9b894cdddbc80 100644 --- a/pyproject.toml +++ b/pyproject.toml @@ -20,6 +20,7 @@ ipykernel = "^6.26.0" compliance-checker = "^5.1.0" cartopy = "^0.22.0" ruff = "^0.1.13" +jupyter = "^1.0.0" [build-system] requires = ["poetry-core"]