|
5 | 5 | "id": "trying-bronze", |
6 | 6 | "metadata": {}, |
7 | 7 | "source": [ |
8 | | - "# Climada documentation" |
| 8 | + "# How to navigate this documentation" |
9 | 9 | ] |
10 | 10 | }, |
11 | 11 | { |
12 | 12 | "cell_type": "markdown", |
13 | 13 | "id": "multiple-radical", |
14 | 14 | "metadata": {}, |
15 | 15 | "source": [ |
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](../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." |
| 16 | + "This page is a short summary of the different sections and guides here, to help you find the information that you need to get started.\n", |
| 17 | + "\n", |
| 18 | + "Each top section has its own landing page, presenting the essential elements in brief, and often several subsections, which go more into details." |
18 | 19 | ] |
19 | 20 | }, |
20 | 21 | { |
21 | | - "attachments": {}, |
22 | 22 | "cell_type": "markdown", |
23 | | - "id": "israeli-street", |
| 23 | + "id": "68085d04-e4ee-45c8-8dbb-41e35bd072a1", |
24 | 24 | "metadata": {}, |
25 | 25 | "source": [ |
26 | | - "## Installation\n", |
27 | | - "\n", |
28 | | - "The first step to getting started is installing CLIMADA. To do so you will need:\n", |
| 26 | + "## Getting started\n", |
29 | 27 | "\n", |
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", |
31 | | - "2. To build a conda environment with the dependencies needed by CLIMADA.\n", |
| 28 | + "The [Getting started](../getting-started/index.rst) section, where you are currently, presents the very basics of climada.\n", |
32 | 29 | "\n", |
33 | | - "For details see the [Installation Instructions](../getting-started/install.rst).\n", |
| 30 | + "For instance, to start learning about CLIMADA, you can have a look at the [introduction](../getting-started/Guide_Introduction.ipynb). \n", |
34 | 31 | "\n", |
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." |
| 32 | + "You can also have a look at the paper [repository](https://github.com/CLIMADA-project/climada_papers) to get an overview of research projects conducted with CLIMADA." |
36 | 33 | ] |
37 | 34 | }, |
38 | 35 | { |
39 | 36 | "cell_type": "markdown", |
40 | 37 | "id": "future-distinction", |
41 | 38 | "metadata": {}, |
42 | 39 | "source": [ |
43 | | - "## Programming in Python\n", |
| 40 | + "### Programming in Python\n", |
| 41 | + "\n", |
44 | 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](../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." |
45 | 43 | ] |
46 | 44 | }, |
|
50 | 48 | "metadata": {}, |
51 | 49 | "source": [ |
52 | 50 | "## Tutorials\n", |
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),...). " |
| 51 | + "A good way to start using CLIMADA is to have a look at the tutorials in the [User Guide](../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),...). " |
54 | 52 | ] |
55 | 53 | }, |
56 | 54 | { |
57 | 55 | "cell_type": "markdown", |
58 | | - "id": "0cc77b19", |
| 56 | + "id": "cd831a52-ea5f-48ee-bf6b-4a6c1a1cdf15", |
59 | 57 | "metadata": {}, |
60 | 58 | "source": [ |
61 | | - "## Documentation\n", |
| 59 | + "## Contributing\n", |
62 | 60 | "\n", |
63 | | - "You can find the documentation of CLIMADA on Read the Docs [online](https://climada-python.readthedocs.io/en/stable/index.html#). Note that the documentation has several versions: 'latest', 'stable' and explicit version numbers, such as 'v3.1.1', in the url path. 'latest' is created from the 'develop' branch and has the latest changes of the developers, 'stable' from the latest release. For more details about documentation versions, please have a look at [here](https://readthedocs.org/projects/climada-python/versions/)." |
| 61 | + "If you would like to participate in the development of CLIMADA, carefully read the [Developer Guide](../development/index.rst). \n", |
| 62 | + "Here you will find how to set up an environment to develop new features for CLIMADA, the workflow and rules to follow to make sure you can implement a valuable contribution!" |
64 | 63 | ] |
65 | 64 | }, |
66 | 65 | { |
67 | 66 | "cell_type": "markdown", |
68 | | - "id": "growing-religious", |
| 67 | + "id": "dc0f6303-e02b-429f-acc3-dd1b23d49be3", |
69 | 68 | "metadata": {}, |
70 | 69 | "source": [ |
71 | | - "## Contributing\n", |
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). " |
| 70 | + "## API Reference\n", |
| 71 | + "\n", |
| 72 | + "The [API reference](../api/index.rst) presents the documentation of the internal modules, classes, methods and function of CLIMADA." |
| 73 | + ] |
| 74 | + }, |
| 75 | + { |
| 76 | + "cell_type": "markdown", |
| 77 | + "id": "6a25d260-336f-439a-8859-00b9b4c1251d", |
| 78 | + "metadata": {}, |
| 79 | + "source": [ |
| 80 | + "## Changelog\n", |
| 81 | + "\n", |
| 82 | + "In the Changelog section, you can have a look at all the changes made between the different versions of CLIMADA" |
| 83 | + ] |
| 84 | + }, |
| 85 | + { |
| 86 | + "cell_type": "markdown", |
| 87 | + "id": "efa8c4fc-706b-40e1-9567-c58dc9f59e0c", |
| 88 | + "metadata": {}, |
| 89 | + "source": [ |
| 90 | + "## External links\n", |
| 91 | + "\n", |
| 92 | + "The top bar of this website also link to the documentation of [Climada Petals](https://climada-petals.readthedocs.io/en/stable/), the webpage of the [Weather and Climate Risk group](https://wcr.ethz.ch/) at ETH, and the official [CLIMADA website](https://climada.ethz.ch/)." |
73 | 93 | ] |
74 | 94 | }, |
75 | 95 | { |
|
0 commit comments