Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Suggest installing CLIMADA via conda in installation instructions #714

Merged
merged 9 commits into from
May 15, 2023
Merged
8 changes: 7 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -19,7 +19,13 @@ This is the Python (3.8+) version of CLIMADA - please see https://github.com/dav

## Getting started

CLIMADA runs on Windows, macOS and Linux. It can be installed from sources or - in case of climada_python - directly with pip. See the [installation guide](https://climada-python.readthedocs.io/en/latest/guide/install.html) for instructions.
CLIMADA runs on Windows, macOS and Linux.
The released versions can be installed directly through Anaconda:
peanutfun marked this conversation as resolved.
Show resolved Hide resolved
```shell
conda install -c conda-forge climada
```
It is **highly recommend** to install CLIMADA into a **separate** Anaconda environment.
peanutfun marked this conversation as resolved.
Show resolved Hide resolved
See the [installation guide](https://climada-python.readthedocs.io/en/latest/guide/install.html) for further information.

Follow the [tutorial](https://climada-python.readthedocs.io/en/latest/tutorial/1_main_climada.html) `climada_python-x.y.z/doc/tutorial/1_main_climada.ipynb` in a Jupyter Notebook to see what can be done with CLIMADA and how.

Expand Down
36 changes: 7 additions & 29 deletions doc/guide/install.rst
Original file line number Diff line number Diff line change
Expand Up @@ -25,9 +25,6 @@ Prerequisites
All dependencies will be downloaded from the internet.
Do **not** use a metered, mobile connection!
* Install `Anaconda`_, following the `installation instructions <https://docs.anaconda.com/anaconda/install/>`_ for your OS.
* Create a **workspace directory**.
To make sure that your user can manipulate it without special privileges, use a subdirectory of your user/home directory.
Do **not** use a directory that is synchronized by cloud storage systems like OneDrive, iCloud or Polybox!
* **Linux** users need to make sure they have ``git`` and ``curl`` installed.
Ubuntu and Debian users may use APT:
peanutfun marked this conversation as resolved.
Show resolved Hide resolved

Expand Down Expand Up @@ -62,29 +59,12 @@ Simple Instructions

These instructions will install the most recent stable version of CLIMADA without cloning its repository.

#. Open the command line and navigate to the workspace directory you created.
The command for entering a directory is ``cd``.
Use the following command, where you replace ``<path/to/workspace>`` with the actual path of the workspace folder:
#. Open the command line.
Create a new conda environment with CLIMADA by executing

.. code-block:: shell

cd <path/to/workspace>

#. Download the Anaconda environment specifications for CLIMADA using ``curl``:

.. code-block:: shell

curl -o env_climada.yml https://raw.githubusercontent.com/CLIMADA-project/climada_python/main/requirements/env_climada.yml

Alternatively, download the file through your browser and place it into the workspace directory: :download:`env_climada.yml </../requirements/env_climada.yml>`

#. Instruct Anaconda to create a new environment called ``climada_env`` from the specification file:

.. code-block:: shell

conda env create -n climada_env -f env_climada.yml

This might take around 5 minutes, depending on your internet connection speed and computer hardware.
conda create -n climada_env -c conda-forge climada

#. Activate the environment:

Expand All @@ -95,12 +75,6 @@ These instructions will install the most recent stable version of CLIMADA withou
You should now see ``(climada_env)`` appear in the beginning of your command prompt.
This means the environment is activated.

#. Download and install the stable CLIMADA version using ``pip``:

.. code-block:: shell

python -m pip install climada

#. Verify that everything is installed correctly by executing a single test:

.. code-block:: shell
Expand All @@ -120,6 +94,10 @@ Advanced Instructions

For advanced Python users or developers of CLIMADA, we recommed cloning the CLIMADA repository and installing the package from source.

#. Create a **workspace directory**.
To make sure that your user can manipulate it without special privileges, use a subdirectory of your user/home directory.
Do **not** use a directory that is synchronized by cloud storage systems like OneDrive, iCloud or Polybox!

#. Open the command line and navigate to the workspace directory you created using ``cd``.
Replace ``<path/to/workspace>`` with the path of the directory that contains the workspace folder:

Expand Down