Update README.md

c9f5c3a4 · Le Roux Erwan · f8952340 · c9f5c3a4
Commit c9f5c3a4 authored 3 years ago by Le Roux Erwan
Hide whitespace changes
Inline Side-by-side

Showing

with 6 additions and 0 deletions
+6 -0
--- a/README.md
+++ b/README.md
@@ -29,3 +29,9 @@ Then, if you download Versions = 2020.2, Areas = Alpes (flat), Products = meteo,
 and run the script "examples/example1.py" you should obtain the following figure:

 ![example1](/uploads/7cef343e16e6e3e1ab7c2fb65ad8e84b/example1.png)
+
+**5. Overview of the main functions**
+
+    study = SafranTemperature(altitude=2100, year_min=2020, year_max=2020)
+    study.massif_name_to_annual_maxima # a dictionary that maps each massif_name to an array of annual maxima
+    study.massif_name_to_annual_maxima['Chartreuse'] # gives the annual maxima for the Chartreuse massif