Skip to content

Commit b442167

Browse files
authored
Update urls in install.rst
1 parent e0d4e7e commit b442167

File tree

1 file changed

+12
-13
lines changed

1 file changed

+12
-13
lines changed

doc/getting-started/install.rst

Lines changed: 12 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -8,18 +8,18 @@ The following sections will guide you through the installation of CLIMADA and it
88

99
CLIMADA has a complicated set of dependencies that cannot be installed with ``pip`` alone.
1010
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.
1212

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**.
1414

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

17-
-------------
18-
Install Conda
19-
-------------
17+
---------------------------
18+
Install environment manager
19+
---------------------------
2020

2121
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).
2323

2424
macOS and Linux
2525
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
@@ -49,7 +49,6 @@ Windows
4949
Decide on Your Entry Level!
5050
---------------------------------------
5151

52-
5352
Depening on your level of expertise, we provide two different approaches:
5453

5554
* 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
130129

131130
.. warning::
132131

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:
134133

135134
.. code-block:: shell
136135
@@ -443,7 +442,7 @@ Apps for working with CLIMADA
443442
---------------------------------------
444443

445444
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/>`_.
447446
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:
448447

449448
.. list-table::
@@ -485,7 +484,7 @@ It is easy to get confused by all the different softwares and their uses so here
485484
- - Automatically checks code changes in GitHub repositories, e.g., when you create a pull request for the develop branch
486485
- Performs static code analysis using pylint
487486
- 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>`_
489488
- Climada Developers
490489

491490
----
@@ -604,12 +603,12 @@ the level set to ``WARNING``.
604603

605604
If you prefer another logging configuration, e.g., for using Climada embedded in another application,
606605
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>`
608607
``climada.conf``.
609608

610609
Changing the logging level can be done in multiple ways:
611610

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.
613612
This only has an effect if the ``logging.climada_style`` is set to ``true`` though.
614613

615614
* Set a global logging level in your Python script:
@@ -708,6 +707,6 @@ IDE
708707

709708

710709
.. _Conda: https://docs.conda.io/en/latest/
711-
.. _Mamba: https://mamba.readthedocs.io/en/latest/
710+
.. _Mamba: https://mamba.readthedocs.io/en/latest/installation/mamba-installation.html
712711
.. _Miniforge: https://github.com/conda-forge/miniforge
713712
.. _CLIMADA Petals: https://climada-petals.readthedocs.io/en/latest/

0 commit comments

Comments
 (0)