Skip to content

Commit f934609

Browse files
committed
Reworks getting-started section
1 parent e958b7c commit f934609

File tree

2 files changed

+57
-4
lines changed

2 files changed

+57
-4
lines changed

doc/getting-started/index.rst

Lines changed: 5 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -60,6 +60,8 @@ You are good to go!
6060
:maxdepth: 1
6161
:hidden:
6262

63-
install
64-
Python Introduction <0_intro_python>
65-
10 minutes CLIMADA <0_10min_climada>
63+
Introduction <Guide_Introduction>
64+
Navigate this documentation <Guide_get_started>
65+
In depth installation instructions <install>
66+
How to cite CLIMADA <../misc/citation>
67+
Python introduction <0_intro_python>

doc/getting-started/install.rst

Lines changed: 52 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -14,6 +14,7 @@ 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+
1718
-------------
1819
Prerequisites
1920
-------------
@@ -41,6 +42,56 @@ For the installation of Miniforge, please scroll to the **Install** section of `
4142

4243
.. 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``.
4344

45+
46+
Apps for working with CLIMADA
47+
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
48+
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:
52+
53+
.. list-table::
54+
:header-rows: 1
55+
:widths: auto
56+
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
94+
4495
.. _install-choice:
4596

4697
Decide on Your Entry Level!
@@ -221,7 +272,7 @@ For advanced Python users or developers of CLIMADA, we recommed cloning the CLIM
221272
If this test passes, great!
222273
You are good to go.
223274

224-
.. _install-dev:
275+
.. _devdeps:
225276

226277
Install Developer Dependencies (Optional)
227278
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^

0 commit comments

Comments
 (0)