You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: doc/getting-started/install.rst
+12-13Lines changed: 12 additions & 13 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -8,18 +8,18 @@ The following sections will guide you through the installation of CLIMADA and it
8
8
9
9
CLIMADA has a complicated set of dependencies that cannot be installed with ``pip`` alone.
10
10
Please follow the installation instructions carefully!
11
-
We recommend to use `Conda`_ for creating a suitable software environment to execute CLIMADA.
11
+
We recommend to use a ``conda``-based python environment manager such as `Mamba`_ or `Conda`_ for creating a suitable software environment to execute CLIMADA.
12
12
13
-
All following instructions should work on any operating system (OS) that is supported by `Conda`_, including in particular: **Windows**, **macOS**, and **Linux**.
13
+
All following instructions should work on any operating system (OS) that is supported by ``conda``, including in particular: **Windows**, **macOS**, and **Linux**.
14
14
15
15
.. hint:: If you need help with the vocabulary used on this page, refer to the :ref:`Glossary <install-glossary>`.
16
16
17
-
-------------
18
-
Install Conda
19
-
-------------
17
+
---------------------------
18
+
Install environment manager
19
+
---------------------------
20
20
21
21
If you haven't already installed an environment management system like `Mamba`_ or `Conda`_, you have to do so now.
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.
22
+
We recommend to use ``mamba`` (see :ref:`conda-instead-of-mamba`) which is available in the installer Miniforge (see below).
23
23
24
24
macOS and Linux
25
25
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
@@ -49,7 +49,6 @@ Windows
49
49
Decide on Your Entry Level!
50
50
---------------------------------------
51
51
52
-
53
52
Depening on your level of expertise, we provide two different approaches:
54
53
55
54
* If you have never worked with a command line, or if you just want to give CLIMADA a try, follow the :ref:`simple instructions <install-simple>`.
@@ -130,7 +129,7 @@ For advanced Python users or developers of CLIMADA, we recommed cloning the CLIM
130
129
131
130
.. warning::
132
131
133
-
If you followed the :ref:`install-simple` before, make sure you **either** remove the environment with
132
+
If you followed the :ref:`install-simple` before, make sure you **either** remove the environment with:
134
133
135
134
.. code-block:: shell
136
135
@@ -443,7 +442,7 @@ Apps for working with CLIMADA
443
442
---------------------------------------
444
443
445
444
To work with CLIMADA, you will need an application that supports Jupyter Notebooks.
446
-
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/).
445
+
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/>`_.
447
446
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:
448
447
449
448
.. list-table::
@@ -485,7 +484,7 @@ It is easy to get confused by all the different softwares and their uses so here
485
484
- - Automatically checks code changes in GitHub repositories, e.g., when you create a pull request for the develop branch
486
485
- Performs static code analysis using pylint
487
486
- You don't need to do any installations yourself; this runs automatically when you push new code to GitHub
488
-
- See `Continuous Integration and GitHub Actions <../guide/Guide_continuous_integration_GitHub_actions.ipynb>`_
487
+
- See `Continuous Integration and GitHub Actions <../development/Guide_continuous_integration_GitHub_actions.ipynb>`_
489
488
- Climada Developers
490
489
491
490
----
@@ -604,12 +603,12 @@ the level set to ``WARNING``.
604
603
605
604
If you prefer another logging configuration, e.g., for using Climada embedded in another application,
606
605
you can opt out of the default pre-configuration by setting the config value for
607
-
``logging.climada_style`` to ``false`` in the :doc:`configuration file <Guide_Configuration>`
606
+
``logging.climada_style`` to ``false`` in the :doc:`configuration file <../development/Guide_Configuration>`
608
607
``climada.conf``.
609
608
610
609
Changing the logging level can be done in multiple ways:
611
610
612
-
* Adjust the :doc:`configuration file <Guide_Configuration>` ``climada.conf`` by setting a the value of the ``global.log_level`` property.
611
+
* Adjust the :doc:`configuration file <../development/Guide_Configuration>` ``climada.conf`` by setting a the value of the ``global.log_level`` property.
613
612
This only has an effect if the ``logging.climada_style`` is set to ``true`` though.
614
613
615
614
* Set a global logging level in your Python script:
0 commit comments