diff --git a/README.md b/README.md index fa603949..b1ad2c87 100644 --- a/README.md +++ b/README.md @@ -55,17 +55,6 @@ Switch to this environment and use `poetry` to restore the package dependencies. > > The name can not contain any spaces or special characters. -#### Anaconda or Miniconda: - -- Create `conda` environment - ```sh - $ conda create -y -c pip --name python=3.11 - ``` -- Activate `conda` environment - ```sh - $ conda activate - ``` - ### venv: - Create `venv` virtual environment @@ -79,6 +68,21 @@ Switch to this environment and use `poetry` to restore the package dependencies. $ .\env\Scripts\activate ``` +#### conda: + + +**⚠ WARNING: Due to licencing of Anaconda, it is recommended to use an alternative like [Miniforge](https://github.com/conda-forge/miniforge). This still uses the package manager conda and therefore the same commands can still be used. The same goes for [Miniconda](https://docs.anaconda.com/miniconda/) but you need to change the defaults channel to conda-forge!** + + +- Create `conda` environment + ```sh + $ conda create -y -c pip --name python=3.11 + ``` +- Activate `conda` environment + ```sh + $ conda activate + ``` + (see [Documentation](https://packaging.python.org/en/latest/guides/installing-using-pip-and-virtual-environments/#creating-a-virtual-environment)) diff --git a/docs/installation.md b/docs/installation.md index 7f5dbf4e..d384367e 100644 --- a/docs/installation.md +++ b/docs/installation.md @@ -2,16 +2,18 @@ D-Eco Impact is a command line operated model. To use D-Eco Impact (currently) an installation of Python and the used libraries is required. This is best achieved by installing D-Eco Impact in a virtual environment. -## Anaconda, miniConda or Visual Studio Code -Anaconda (elaborate functionality) and minicoda (minimum functionality) are environment managers often used in combination with Python. You can find the installation for either here: +## Conda or Visual Studio Code +Conda is a package and environment manager that can be used to install the poetry package and other packages needed to run D-Eco Impact. -- [Anaconda](https://docs.anaconda.com/anaconda/install/windows/) -- [miniConda](https://docs.conda.io/en/main/miniconda.html) +- [Miniforge](https://github.com/conda-forge/miniforge) +- [Miniconda](https://docs.conda.io/en/main/miniconda.html) - [Visual Studio code](https://code.visualstudio.com/download) -## Installation of D-Eco Impact with Anaconda or miniConda +## Installation of D-Eco Impact with conda (use Miniforge or Miniconda) -1. Open your commandline (cmd) or conda prompt, and execute: +Note: when using miniconda, make sure to update the defaults channel to conda-forge! + +1. Open a commandline tool (eg. cmd or powershell): ```sh $ conda create -y -c conda-forge --name python=3.11 ``` @@ -46,7 +48,7 @@ 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. +NB. If errors occur while installing the libraries, this might have to do with your administrative rights. Either start the cmd promt “As administrator” or discuss this with your IT support. 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: