Skip to content

Commit ca6b749

Browse files
updated conda installation instructions for different OS
1 parent ef1c452 commit ca6b749

File tree

1 file changed

+70
-68
lines changed

1 file changed

+70
-68
lines changed

doc/getting-started/install.rst

Lines changed: 70 additions & 68 deletions
Original file line numberDiff line numberDiff line change
@@ -14,88 +14,40 @@ All following instructions should work on any operating system (OS) that is supp
1414

1515
.. hint:: If you need help with the vocabulary used on this page, refer to the :ref:`Glossary <install-glossary>`.
1616

17-
1817
-------------
19-
Prerequisites
18+
Install Conda
2019
-------------
2120

22-
* Make sure you are using the **latest version** of your OS. Install any outstanding **updates**.
23-
* Free up at least 10 GB of **free storage space** on your machine.
24-
Conda and the CLIMADA dependencies will require around 5 GB of free space, and you will need at least that much additional space for storing the input and output data of CLIMADA.
25-
* Ensure a **stable internet connection** for the installation procedure.
26-
All dependencies will be downloaded from the internet.
27-
Do **not** use a metered, mobile connection!
28-
29-
.. note:: When mentioning the terms "terminal" or "command line" in the following, we are referring to the "Terminal" apps on macOS or Linux and the "Miniforge Prompt" on Windows.
30-
31-
Install Mamba or Conda
32-
^^^^^^^^^^^^^^^^^^^^^^^^^^^
33-
3421
If you haven't already installed an environment management system like `Mamba`_ or `Conda`_, you have to do so now.
35-
We recommend to use ``mamba`` (see :ref:`conda-instead-of-mamba`) which is available in the installer Miniforge.
36-
37-
For the installation of Miniforge, please scroll to the **Install** section of `Miniforge`_ and follow the respective installation instructions for your OS.
38-
39-
.. attention:: After accepting the license terms and confirming the location, you are asked if you wish to update your shell profile to automatically initialize conda. **Do not just hit ENTER but first type the choice 'yes'**.
22+
We recommend to use ``mamba`` (see :ref:`conda-instead-of-mamba`) which is available in the installer Miniforge, and can be installed as follows.
4023

41-
.. note:: If you encounter ``command not found: mamba``, open a new terminal window.
24+
macOS and Linux
25+
"""""""""""
4226

43-
.. note:: If you encounter ``Run 'mamba init' to be able to run mamba activate/deactivate and start a new shell session. Or use conda to activate/deactivate.``, please run ``mamba init zsh`` or ``mamba init``.
27+
* Open the "Terminal" app, copy-paste the two commands below, and hit enter:
4428

29+
.. code-block:: shell
4530
46-
Apps for working with CLIMADA
47-
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
31+
curl -L -O "https://github.com/conda-forge/miniforge/releases/latest/download/Miniforge3-$(uname)-$(uname -m).sh"
32+
bash Miniforge3-$(uname)-$(uname -m).sh
4833
49-
To work with CLIMADA, you will need an application that supports Jupyter Notebooks.
50-
There are plugins available for nearly every code editor or IDE, but if you are unsure about which to choose, we recommend [JupyterLab](https://jupyterlab.readthedocs.io/en/stable/), [Visual Studio Code](https://code.visualstudio.com/) or [Spyder](https://www.spyder-ide.org/).
51-
It is easy to get confused by all the different softwares and their uses so here is an overview of which tools we use for what:
34+
* Accept the license terms.
35+
* You can confirm the default location.
36+
* Answer 'yes' when asked if if you wish to update your shell profile to automatically initialize conda. **Do not just hit ENTER but first type 'yes'**
37+
* If at some point you encounter ``command not found: mamba``, open a new terminal window.
38+
* If you encounter ``Run 'mamba init' to be able to run mamba activate/deactivate ...``, please run ``mamba init zsh`` or ``mamba init``.
5239

53-
.. list-table::
54-
:header-rows: 1
55-
:widths: auto
40+
Windows
41+
"""""""""""
5642

57-
* - Use
58-
- Tools
59-
- Description
60-
- Useful for
61-
* - Distribution / manage virtual environment & packages
62-
- **Recommended:**
63-
Mamba
64-
**Alternatives:**
65-
Anaconda
66-
- - Install climada, manage & use the climada virtual environment, install packages
67-
- Anaconda includes Anaconda Navigator, which is a desktop GUI and can be used to launch applications like Jupyter Notebook, Spyder, etc.
68-
- Climada Users
69-
& Developers
70-
* - IDE (Integrated Development Environment)
71-
- **Recommended:**
72-
VSCode
73-
**Alternatives:**
74-
Spyder, JupyterLab, PyCharm, & many more
75-
- - Write and run code
76-
- Useful for Developers:
77-
- VSCode also has a GUI to commit changes to Git (similar to GitHub Desktop, but in the same place as your code)
78-
- VSCode test explorer shows results for individual tests & any classes and files containing those tests (folders display a failure or pass icon)
79-
- Climada Users
80-
& Developers
81-
* - Git GUI (Graphical User Interface)
82-
- GitHub Desktop, GitKraken
83-
- - Provides an interface which keeps track of the branch you’re working on, changes you made, etc.
84-
- Allows you to commit changes, push to GitHub, etc. without having to use the command line
85-
- The code itself is not written using these applications but with your IDE of choice (see above)
86-
- Climada Developers
87-
* - Continuous integration (CI) server
88-
- Jenkins
89-
- - Automatically checks code changes in GitHub repositories, e.g., when you create a pull request for the develop branch
90-
- Performs static code analysis using pylint
91-
- You don't need to do any installations yourself; this runs automatically when you push new code to GitHub
92-
- See `Continuous Integration and GitHub Actions <../guide/Guide_continuous_integration_GitHub_actions.ipynb>`_
93-
- Climada Developers
43+
* Download the Windows installer at the Install section from `Miniforge`_.
44+
* Execute the installer. This will install Mamba and provide the "Miniforge Prompt" program as a command line replacement.
9445

9546
.. _install-choice:
96-
47+
-------------
9748
Decide on Your Entry Level!
98-
^^^^^^^^^^^^^^^^^^^^^^^^^^^
49+
-------------
50+
9951

10052
Depening on your level of expertise, we provide two different approaches:
10153

@@ -481,6 +433,56 @@ Therefore, we recommend installing Spyder in a *separate* environment, and then
481433
#. Set the Python interpreter used by Spyder to the one of ``climada_env``.
482434
Select *Preferences* > *Python Interpreter* > *Use the following interpreter* and paste the iterpreter path you copied from the ``climada_env``.
483435

436+
-------------
437+
Apps for working with CLIMADA
438+
-------------
439+
440+
To work with CLIMADA, you will need an application that supports Jupyter Notebooks.
441+
There are plugins available for nearly every code editor or IDE, but if you are unsure about which to choose, we recommend [JupyterLab](https://jupyterlab.readthedocs.io/en/stable/), [Visual Studio Code](https://code.visualstudio.com/) or [Spyder](https://www.spyder-ide.org/).
442+
It is easy to get confused by all the different softwares and their uses so here is an overview of which tools we use for what:
443+
444+
.. list-table::
445+
:header-rows: 1
446+
:widths: auto
447+
448+
* - Use
449+
- Tools
450+
- Description
451+
- Useful for
452+
* - Distribution / manage virtual environment & packages
453+
- **Recommended:**
454+
Mamba
455+
**Alternatives:**
456+
Anaconda
457+
- - Install climada, manage & use the climada virtual environment, install packages
458+
- Anaconda includes Anaconda Navigator, which is a desktop GUI and can be used to launch applications like Jupyter Notebook, Spyder, etc.
459+
- Climada Users
460+
& Developers
461+
* - IDE (Integrated Development Environment)
462+
- **Recommended:**
463+
VSCode
464+
**Alternatives:**
465+
Spyder, JupyterLab, PyCharm, & many more
466+
- - Write and run code
467+
- Useful for Developers:
468+
- VSCode also has a GUI to commit changes to Git (similar to GitHub Desktop, but in the same place as your code)
469+
- VSCode test explorer shows results for individual tests & any classes and files containing those tests (folders display a failure or pass icon)
470+
- Climada Users
471+
& Developers
472+
* - Git GUI (Graphical User Interface)
473+
- GitHub Desktop, GitKraken
474+
- - Provides an interface which keeps track of the branch you’re working on, changes you made, etc.
475+
- Allows you to commit changes, push to GitHub, etc. without having to use the command line
476+
- The code itself is not written using these applications but with your IDE of choice (see above)
477+
- Climada Developers
478+
* - Continuous integration (CI) server
479+
- Jenkins
480+
- - Automatically checks code changes in GitHub repositories, e.g., when you create a pull request for the develop branch
481+
- Performs static code analysis using pylint
482+
- You don't need to do any installations yourself; this runs automatically when you push new code to GitHub
483+
- See `Continuous Integration and GitHub Actions <../guide/Guide_continuous_integration_GitHub_actions.ipynb>`_
484+
- Climada Developers
485+
484486
----
485487
FAQs
486488
----

0 commit comments

Comments
 (0)