Doc and code tweaks

README.rst

@@ -114,16 +114,14 @@ Advanced example
 .. code:: python
 
     import pyhector
-    from pyhector import rcp26, rcp45, rcp60, rcp85
-
     import matplotlib.pyplot as plt
+    from pyhector import ssp119, ssp126, ssp245, ssp370, ssp434, ssp460, ssp534_over, ssp585
 
-    for rcp in [rcp26, rcp45, rcp60, rcp85]:
-        output = pyhector.run(rcp, {"core": {"endDate": 2100}})
-        temp = output["temperature.Tgav"]
-        # Adjust to 1850 - 1900 reference period
+    for ssp in [ssp119, ssp126, ssp245, ssp370, ssp434, ssp460, ssp534_over, ssp585]:
+        output = pyhector.run(ssp, {"core": {"endDate": 2100}})
+        temp = output["temperature.global_tas"]
         temp = temp.loc[1850:] - temp.loc[1850:1900].mean()
-        temp.plot(label=rcp.name.split("_")[0])
+        temp.plot(label=ssp.name)
     plt.title("Global mean temperature")
     plt.ylabel("°C over pre-industrial (1850-1900 mean)")
     plt.legend(loc="best")

docs/pyhector.rst

@@ -15,7 +15,7 @@ pyhector.default_config
 -----------------------
 
 A dictionary with Hector's default configuration parameters.
-See also `the original config file on GitHub <https://github.com/openclimatedata/pyhector/blob/main/pyhector/rcp_default.ini>`_.
+See also `the original config file on GitHub <https://github.com/JGCRI/hector/blob/main/inst/input/hector_ssp119.ini>`_.
 In **pyhector** this INI-file is represented as a dictionary.
 
 

docs/usage.rst

@@ -3,7 +3,7 @@
     :end-before: image-start
 
 .. image:: example-plot.png
-    :alt: Temperature Plot of RCP scenarios
+    :alt: Temperature Plot of SSP scenarios
 
 .. include:: ../README.rst
     :start-after: image-end

scripts/plot_example.py

@@ -13,11 +13,11 @@
 
 path = os.path.join(os.path.dirname(__file__), "../docs/example-plot.png")
 
-for rcp in [ssp119, ssp126, ssp245, ssp370, ssp434, ssp460, ssp534_over, ssp585]:
-    output = pyhector.run(rcp, {"core": {"endDate": 2100}})
+for ssp in [ssp119, ssp126, ssp245, ssp370, ssp434, ssp460, ssp534_over, ssp585]:
+    output = pyhector.run(ssp, {"core": {"endDate": 2100}})
     temp = output["temperature.global_tas"]
     temp = temp.loc[1850:] - temp.loc[1850:1900].mean()
-    temp.plot(label=rcp.name.split("_")[0])
+    temp.plot(label=ssp.name)
 plt.title("Global mean temperature")
 plt.ylabel("°C over pre-industrial (1850-1900 mean)")
 plt.legend(loc="best")