Skip to content

Commit ce65c1a

Browse files
authored
Add colab example (#153)
* Add My first Nowcast example prepared to run in Google Colab. * Add Run in Colab badge in the readme * Add a Run your first nowcast! to the documentation's home. Co-authored-by: Daniele Nerini and Ruben Imhoff
1 parent 602bdd8 commit ce65c1a

File tree

4 files changed

+849
-3
lines changed

4 files changed

+849
-3
lines changed

README.rst

Lines changed: 14 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -18,6 +18,8 @@ pySTEPS - Python framework for short-term ensemble prediction systems
1818
- |license|
1919
* - community
2020
- |slack| |contributors| |downloads|
21+
* - tutorials
22+
- |colab|
2123

2224
.. |docs| image:: https://readthedocs.org/projects/pysteps/badge/?version=latest
2325
:alt: Documentation Status
@@ -62,7 +64,10 @@ pySTEPS - Python framework for short-term ensemble prediction systems
6264
.. |downloads| image:: https://img.shields.io/conda/dn/conda-forge/pysteps
6365
:alt: Conda downloads
6466
:target: https://anaconda.org/conda-forge/pysteps
65-
67+
68+
.. |colab| image:: https://colab.research.google.com/assets/colab-badge.svg
69+
:alt: Conda downloads
70+
:target: https://colab.research.google.com/github/pySTEPS/pysteps/blob/master/examples/my_first_nowcast.ipynb
6671

6772
.. end-badges
6873
@@ -75,6 +80,14 @@ The aim of pysteps is to serve two different needs. The first is to provide a mo
7580

7681
The pysteps library supports standard input/output file formats and implements several optical flow methods as well as advanced stochastic generators to produce ensemble nowcasts. In addition, it includes tools for visualizing and post-processing the nowcasts and methods for deterministic, probabilistic, and neighbourhood forecast verification.
7782

83+
84+
Run your first nowcast!
85+
-----------------------
86+
87+
Use pysteps to compute and plot an extrapolation nowcast in Google Colab with `this interactive notebook`__.
88+
89+
__ https://colab.research.google.com/github/pySTEPS/pysteps/blob/master/examples/my_first_nowcast.ipynb
90+
7891
Get in touch
7992
============
8093

doc/source/conf.py

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -235,5 +235,5 @@ def set_root():
235235
sphinx_gallery_conf = {
236236
'examples_dirs': '../../examples', # path to your example scripts
237237
'gallery_dirs': 'auto_examples', # path where to save gallery generated examples
238-
'filename_pattern': '/*', # Include all the files in the examples dir
238+
'filename_pattern': r'/*\.py', # Include all the files in the examples dir
239239
}

doc/source/index.rst

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -20,14 +20,15 @@ probabilistic precipitation nowcasting (v1.0). *Geosci. Model Dev.*, **12 (10)**
2020
__ https://github.com/pySTEPS/pysteps
2121
__ https://doi.org/10.5194/gmd-12-4185-2019
2222

23+
.. note:: Use pysteps to run your first extrapolation nowcast in Google Colab with `this interactive notebook`__.
24+
__ https://colab.research.google.com/github/pySTEPS/pysteps/blob/master/examples/my_first_nowcast.ipynb
2325

2426
Documentation
2527
=============
2628

2729
The documentation is separated in three big branches, intended for different
2830
audiences.
2931

30-
3132
:ref:`user-guide`
3233
~~~~~~~~~~~~~~~~~
3334

0 commit comments

Comments
 (0)