From 20b09f2992241ba6123b82e5545ca668fd68dd17 Mon Sep 17 00:00:00 2001 From: Wouter Date: Thu, 28 Mar 2024 16:16:36 +0100 Subject: [PATCH 1/3] fix[DEI-177]: update documentation on using poetry --- docs/installation.md | 22 +++++++++++++++++++--- 1 file changed, 19 insertions(+), 3 deletions(-) diff --git a/docs/installation.md b/docs/installation.md index 6124a50e..12e8b693 100644 --- a/docs/installation.md +++ b/docs/installation.md @@ -13,7 +13,7 @@ Anaconda (elaborate functionality) and minicoda (minimum functionality) are envi 1. Open your commandline (cmd) or conda prompt, and execute: ```sh - $ conda create -y -c conda-forge --name poetry python=3.11 + $ conda create -y -c conda-forge --name python=3.11 ``` 2. Activate the newly created environment @@ -24,14 +24,30 @@ Anaconda (elaborate functionality) and minicoda (minimum functionality) are envi 3. Move to the folder where you have placed the D-Eco Impact source code You can use cd ../ and cd to move to the location or use windows explorer and type “cmd” + enter in the path bar. -4. To install the required libraries Poetry is used. Poetry makes use of the poetry.lock and pyproject.toml (present in the D-Eco Impact folder) to find these required libraries. +4. To install the required libraries Poetry is used. +Use poetry 1.3 or higher: ([installation instructions](https://python-poetry.org/docs/#installation)) +If you prefer to install poetry with conda then we recommed to install poetry only to the base environment: +Activate base environment: +```sh +$ conda activate base +``` +Install poetry using conda: +```sh +$ conda activate base +``` +Activate your created environment: +```sh +$ conda activate +``` + +5. Poetry makes use of the poetry.lock and pyproject.toml (present in the D-Eco Impact folder) to find these required libraries. Execute the following command: ``` poetry install ``` NB. If errors occur while installing the libraries, this might have to do with your administrative rights. Either start the cmd or conda promt “As administrator” or discuss this with your IT support. -5. Now D-Eco Impact is setup for use. You can test this by executing one of the input yaml files. +6. Now D-Eco Impact is setup for use. You can test this by executing one of the input yaml files. To execute use the following in the command prompt while your environment is active: ``` python main.py .yaml From a2b7356bd76e4ca66ab9a1b5c1e95fde21770124 Mon Sep 17 00:00:00 2001 From: Wouter Date: Fri, 29 Mar 2024 13:20:57 +0100 Subject: [PATCH 2/3] fix[DEI-177]: fix docs on how to install poetry --- docs/installation.md | 7 ++++--- 1 file changed, 4 insertions(+), 3 deletions(-) diff --git a/docs/installation.md b/docs/installation.md index 12e8b693..3cf2f888 100644 --- a/docs/installation.md +++ b/docs/installation.md @@ -26,14 +26,15 @@ You can use cd ../ and cd to move to the location or use windows e 4. To install the required libraries Poetry is used. Use poetry 1.3 or higher: ([installation instructions](https://python-poetry.org/docs/#installation)) -If you prefer to install poetry with conda then we recommed to install poetry only to the base environment: +If you prefer to install poetry with conda then we recommed to install poetry only to the base environment. + Activate base environment: ```sh $ conda activate base ``` -Install poetry using conda: +Install poetry using pip: ```sh -$ conda activate base +$ pip install poetry ``` Activate your created environment: ```sh From ff27404ed66bff92c8b06596a5869611f03bdae4 Mon Sep 17 00:00:00 2001 From: Wouter Date: Tue, 2 Apr 2024 15:17:49 +0200 Subject: [PATCH 3/3] fix[DEI-177]: correct spelling error --- docs/installation.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/installation.md b/docs/installation.md index 3cf2f888..6b7806b8 100644 --- a/docs/installation.md +++ b/docs/installation.md @@ -48,7 +48,7 @@ Execute the following command: ``` NB. If errors occur while installing the libraries, this might have to do with your administrative rights. Either start the cmd or conda promt “As administrator” or discuss this with your IT support. -6. Now D-Eco Impact is setup for use. You can test this by executing one of the input yaml files. +6. Now D-Eco Impact is ready to use. You can test this by executing one of the input yaml files. To execute use the following in the command prompt while your environment is active: ``` python main.py .yaml