Skip to content

Commit c9d7bbf

Browse files
committed
index and tutorials doc update
1 parent 322e663 commit c9d7bbf

2 files changed

Lines changed: 40 additions & 17 deletions

File tree

docs/index.md

Lines changed: 13 additions & 17 deletions
Original file line numberDiff line numberDiff line change
@@ -11,27 +11,23 @@ For more details on the model and results, check out our publications listed in
1111

1212
The authors are [Giacomo Acciarini](https://www.esa.int/gsp/ACT/team/giacomo_acciarini/), [Atılım Güneş Baydin](https://gbaydin.github.io/), [Dario Izzo](https://www.esa.int/gsp/ACT/team/dario_izzo/). The main developer is Giacomo Acciarini (giacomo.acciarini@gmail.com).
1313

14-
:maxdepth: 1
15-
:caption: Getting started
1614

17-
install.rst
18-
capabilities
19-
credits
15+
```{toctree}
16+
:maxdepth: 1
17+
:caption: Getting Started
2018
19+
install
20+
capabilities
21+
credits
22+
```
2123

22-
:maxdepth: 1
23-
:caption: Tutorials
24+
```{toctree}
25+
:maxdepth: 1
26+
:caption: Contents
2427
25-
notebooks/basics
26-
notebooks/cdms_analysis_and_plotting
27-
notebooks/LSTM_training
28-
notebooks/probabilistic_programming_module
29-
30-
31-
:maxdepth: 1
32-
:caption: API documentation
33-
34-
api
28+
tutorials
29+
api
30+
```
3531

3632
Indices and tables
3733
==================

docs/tutorials.rst

Lines changed: 27 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,27 @@
1+
.. _tutorials:
2+
3+
Tutorials
4+
===============
5+
6+
Basics
7+
^^^^^^^^^^^
8+
These tutorials include some basic examples on how to use kessler
9+
10+
.. toctree::
11+
:maxdepth: 1
12+
13+
notebooks/basics.ipynb
14+
notebooks/cdms_analysis_and_plotting.ipynb
15+
16+
Advanced
17+
^^^^^^^^^^^
18+
These tutorials are more advanced examples on how to leverage kessler framework
19+
for more complex tasks. In particular, we will cover both the deep learning module (where
20+
kessler is used to predict CDMs) and the probabilistic programming one (where kessler is used
21+
as a probabilistic generative model for CDMs)
22+
23+
.. toctree::
24+
:maxdepth: 1
25+
26+
notebooks/LSTM_training.ipynb
27+
notebooks/probabilistic_programming_module.ipynb

0 commit comments

Comments
 (0)