From a74a9f463020a25ad8d3d45b664ab4c806bc88f2 Mon Sep 17 00:00:00 2001 From: Carsten Hinz <c.hinz@fz-juelich.de> Date: Tue, 14 May 2024 16:07:37 +0200 Subject: [PATCH] added jupyter as dependency added info how to run scripts/notebooks with poetry --- README.md | 12 +++++++++++- pyproject.toml | 1 + 2 files changed, 12 insertions(+), 1 deletion(-) diff --git a/README.md b/README.md index d55e2ce..2455c57 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 1decdb1..4137448 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"] -- GitLab