|
14 | 14 | "metadata": {}, |
15 | 15 | "source": [ |
16 | 16 | "This is a short summary of the guides to help you find the information that you need to get started.\n", |
17 | | - "To learn more about CLIMADA, have a look at the [introduction](../guide/Guide_Introduction.ipynb). You can also have a look at the paper [repository](https://github.com/CLIMADA-project/climada_papers) to get an overview of research projects." |
| 17 | + "To learn more about CLIMADA, have a look at the [introduction](../getting-started/Guide_Introduction.ipynb). You can also have a look at the paper [repository](https://github.com/CLIMADA-project/climada_papers) to get an overview of research projects." |
18 | 18 | ] |
19 | 19 | }, |
20 | 20 | { |
|
24 | 24 | "metadata": {}, |
25 | 25 | "source": [ |
26 | 26 | "## Installation\n", |
| 27 | + "\n", |
27 | 28 | "The first step to getting started is installing CLIMADA. To do so you will need:\n", |
| 29 | + "\n", |
28 | 30 | "1. To get the lastest release from the git repository [CLIMADA releases](https://github.com/climada-project/climada_python/releases) or clone the project with git if you are interested in contributing to the development.\n", |
29 | | - "2. To build a conda environment with the dependencies needed by CLIMADA. \n", |
| 31 | + "2. To build a conda environment with the dependencies needed by CLIMADA.\n", |
30 | 32 | "\n", |
31 | | - "For details see the [Installation Instructions](install.rst).\n", |
| 33 | + "For details see the [Installation Instructions](../getting-started/install.rst).\n", |
32 | 34 | "\n", |
33 | | - "If you need to run a model on a computational cluster, have a look at [this guide](Guide_Euler.ipynb) to install CLIMADA and run your jobs." |
| 35 | + "If you need to run a model on a computational cluster, have a look at [this guide](../development/Guide_Euler.ipynb) to install CLIMADA and run your jobs." |
34 | 36 | ] |
35 | 37 | }, |
36 | 38 | { |
|
39 | 41 | "metadata": {}, |
40 | 42 | "source": [ |
41 | 43 | "## Programming in Python\n", |
42 | | - "It is best to have some basic knowledge of Python programming before starting with CLIMADA. But if you need a quick introduction or reminder, have a look at the short [Python Tutorial](../tutorial/0_intro_python.ipynb). Also have a look at the python [Python Dos and Don't](../guide/Guide_PythonDos-n-Donts.ipynb) guide and at the [Python Performance Guide](../guide/Guide_Py_Performance.ipynb) for best practice tips." |
| 44 | + "It is best to have some basic knowledge of Python programming before starting with CLIMADA. But if you need a quick introduction or reminder, have a look at the short [Python Tutorial](../getting-started/0_intro_python.ipynb). Also have a look at the python [Python Dos and Don't](../development/Guide_PythonDos-n-Donts.ipynb) guide and at the [Python Performance Guide](../development/Guide_Py_Performance.ipynb) for best practice tips." |
43 | 45 | ] |
44 | 46 | }, |
45 | 47 | { |
|
48 | 50 | "metadata": {}, |
49 | 51 | "source": [ |
50 | 52 | "## Tutorials\n", |
51 | | - "A good way to start using CLIMADA is to have a look at the [Tutorials](https://github.com/CLIMADA-project/climada_python/tree/main/doc/tutorial). The [Main Tutorial](../tutorial/1_main_climada.ipynb) will introduce you the structure of CLIMADA and how to calculate you first impacts, as well as your first appraisal of adaptation options. You can then look at the specific tutorials for each module (for example if you are interested in a specific hazard, like [Tropical Cyclones](../tutorial/climada_hazard_TropCyclone.ipynb), or in learning to [estimate the value of asset exposure](../tutorial/climada_entity_LitPop.ipynb),...). " |
| 53 | + "A good way to start using CLIMADA is to have a look at the [Tutorials](../user-guide/index.rst). The [10 minute climada](../user-guide/0_10min_climada.ipynb) tutorial will give you a quick introduction to CLIMADA, with a brief example on how to calculate you first impacts, as well as your first appraisal of adaptation options, while the [Overview](../user-guide/1_main_climada.ipynb) will present the whole structure of CLIMADA more in depth. You can then look at the specific tutorials for each module (for example if you are interested in a specific hazard, like [Tropical Cyclones](../user-guide/climada_hazard_TropCyclone.ipynb), or in learning to [estimate the value of asset exposure](../user-guide/climada_entity_LitPop.ipynb),...). " |
52 | 54 | ] |
53 | 55 | }, |
54 | 56 | { |
|
67 | 69 | "metadata": {}, |
68 | 70 | "source": [ |
69 | 71 | "## Contributing\n", |
70 | | - "If you would like to participate in the development of CLIMADA, carefully read the [Git and Development Guide](../guide/Guide_Git_Development.ipynb). Before making a new feature, discuss with one of the repository admins (Now Chahan, Emmanuel and David). Every new feature or enhancement should be done on a separate branch, which will be merged in the develop branch after being reviewed (see [Checklist](../guide/Guide_Review.ipynb)). Finally, the develop branch is merged in the main branch in each CLIMADA release. Each new feature should come with a tutorial and with [Unit and Integration Tests](../guide/Guide_Testing.ipynb). " |
| 72 | + "If you would like to participate in the development of CLIMADA, carefully read the [Git and Development Guide](../development/Guide_Git_Development.ipynb). Before making a new feature, discuss with one of the repository admins (Now Chahan, Emmanuel and David). Every new feature or enhancement should be done on a separate branch, which will be merged in the develop branch after being reviewed (see [Checklist](../development/Guide_Review.ipynb)). Finally, the develop branch is merged in the main branch in each CLIMADA release. Each new feature should come with a tutorial and with [Unit and Integration Tests](../development/Guide_Testing.ipynb). " |
71 | 73 | ] |
72 | 74 | }, |
73 | 75 | { |
|
0 commit comments