Docs update

polca · Oct 13, 2024 · 7e46bbd · 7e46bbd
1 parent 6d10aaf
commit 7e46bbd
Show file tree

Hide file tree

Showing 4 changed files with 38 additions and 29 deletions.
diff --git a/docs/extract.rst b/docs/extract.rst
@@ -21,7 +21,7 @@ Concentration Pathway (RCP)—and a year (e.g., SSP1, Base, 2035).
 
 +------------------+-----------------------+------------------------------------------------------------------------------------+---------------------------------------------+-----------------+------------+------------+
 | SSP/RCP scenario | GMST increase by 2100 | Society/economy trend                                                              | Climate policy                              | REMIND          | IMAGE      | TIAM-UCL   |
-+==================+=======================+====================================================================================+=============================================+=================+============+-===========+
++==================+=======================+====================================================================================+=============================================+=================+============+============+
 +------------------+-----------------------+------------------------------------------------------------------------------------+---------------------------------------------+-----------------+------------+------------+
 | SSP1-None        | 2.3-2.8 °C            | Optimistic trends for human develop. and economy, driven by sustainable practices. | None                                        | SSP1-Base       | SSP1-Base  |            |
 +------------------+-----------------------+------------------------------------------------------------------------------------+---------------------------------------------+-----------------+------------+------------+

diff --git a/docs/main_workflow.png b/docs/main_workflow.png
diff --git a/docs/user_scenarios.rst b/docs/user_scenarios.rst
@@ -38,17 +38,20 @@ Example
     fp = r"https://raw.githubusercontent.com/premise-community-scenarios/cobalt-perspective-2050/main/datapackage.json"
     cobalt = Package(fp)
 
+    external_scenario = [
+        {"scenario": "Sustainable development", "data": cobalt},
+    ] # several different scenarios can be listed here
+
+
     ndb = NewDatabase(
-    scenarios = [
-        {"model":"image", "pathway":"SSP2-Base", "year":2025},
-        {"model":"image", "pathway":"SSP2-Base", "year":2030},
-    ],
-    source_db="ecoinvent cutoff 3.8",
-    source_version="3.8",
-    key='xxxxxxx',
-    external_scenarios=[
-        cobalt,
-    ]
+        scenarios = [
+            {"model":"image", "pathway":"SSP2-Base", "year":2025, "external scenarios": external_scenario},
+            {"model":"image", "pathway":"SSP2-Base", "year":2030, "external scenarios": external_scenario},
+        ],
+        source_db="ecoinvent cutoff 3.8",
+        source_version="3.8",
+        key='xxxxxxx',
+    )
 
 
 The function **ndb.update("external")** can be called after that

diff --git a/examples/examples.ipynb b/examples/examples.ipynb
@@ -106,6 +106,13 @@
     "* \"SSP2-RCP26\"\n",
     "* \"SSP2-RCP19\"\n",
     "\n",
+    "With TIAM-UCL, the following SSP/RCP scenarios are available:\n",
+    "* \"SSP2-Base\"\n",
+    "* \"SSP2-RCP45\"\n",
+    "* \"SSP2-RCP26\"\n",
+    "* \"SSP2-RCP19\"\n",
+    "\n",
+    "\n",
     "Refer to [the documentation](https://premise.readthedocs.io/en/latest/extract.html#current-iam-scenarios) for a description of theses scenarios, or have a look at our **[scenario explorer](https://premisedash-6f5a0259c487.herokuapp.com/)**.\n",
     "Additionally, [this blog](https://www.carbonbrief.org/explainer-how-shared-socioeconomic-pathways-explore-future-climate-change/) is a good reading material to understand SSPs and RCPs.\n"
    ]
@@ -160,24 +167,23 @@
    "source": [
     "Here is a list of all arguments that can be passed to `NewDatabase()`:\n",
     "    \n",
-    "    scenarios: List[dict],\n",
-    "    source_version: str = \"3.10\",\n",
-    "    source_type: str = \"brightway\",\n",
-    "    key: bytes = None,\n",
-    "    source_db: str = None,\n",
-    "    source_file_path: str = None,\n",
-    "    additional_inventories: List[dict] = None,\n",
-    "    system_model: str = \"cutoff\",\n",
-    "    system_args: dict = None,\n",
-    "    use_cached_inventories: bool = True,\n",
-    "    use_cached_database: bool = True,\n",
-    "    external_scenarios: list = None,\n",
-    "    quiet=False,\n",
-    "    keep_imports_uncertainty=False,\n",
-    "    keep_source_db_uncertainty=False,\n",
-    "    gains_scenario=\"CLE\",\n",
-    "    use_absolute_efficiency=False,\n",
-    "    biosphere_name: str = \"biosphere3\","
+    "    scenarios: List[dict], # list of scenarios to process\n",
+    "    source_version: str = \"3.10\", # version of ecoinvent database. Can be \"3.6\", \"3.7\", \"3.8\", \"3.9\" or \"3.10\".\n",
+    "    source_type: str = \"brightway\", # type of source database. Can be \"brightway\" or \"ecospold\".\n",
+    "    key: bytes = None, # decryption key\n",
+    "    source_db: str = None, # name of database if source_type is \"brightway\"\n",
+    "    source_file_path: str = None, # path to ecospold files if source_type is \"ecospold\"\n",
+    "    additional_inventories: List[dict] = None, # list of additional inventories to import\n",
+    "    system_model: str = \"cutoff\", # system model. Can be \"cutoff\" or \"consequential\".\n",
+    "    system_args: dict = None, # arguments for the \"consequential \"system model\n",
+    "    use_cached_inventories: bool = True, # use cached inventories\n",
+    "    use_cached_database: bool = True, # use cached database\n",
+    "    quiet=False, # suppress output\n",
+    "    keep_imports_uncertainty=False, # keep uncertainty data of additional inventories\n",
+    "    keep_source_db_uncertainty=False, # keep uncertainty data of source database\n",
+    "    gains_scenario=\"CLE\", # Air pollutionn GAINS scenario\n",
+    "    use_absolute_efficiency=False, # use IAM's absolute efficiencies instead of efficiencies relative to 2020\n",
+    "    biosphere_name: str = \"biosphere3\", # name of biosphere database in brightway project if different from \"biosphere3\""
    ]
   },
   {