@@ -68,3 +68,51 @@ To select other (non-default) versions, you can use the "Switch to Advanced View
68
68
in the scenario-selection tab of an IIASA Scenario Explorer or you can use the
69
69
:code: `default_only=False ` option of the function :func: `pyam.read_iiasa() `
70
70
or the **ixmp4 ** package (`read the docs <https://docs.ece.iiasa.ac.at/ixmp4 >`_).
71
+
72
+ Scenario processing
73
+ -------------------
74
+
75
+ When submitting a scenario (a.k.a. "run") to an IIASA database instance, the server
76
+ executes a scenario-processing workflow including *region-aggregation * and
77
+ *scenario validation * prior to saving the scenario to the database. The processing uses
78
+ the **nomenclature ** package (`read the docs <https://nomenclature-iamc.readthedocs.io >`_).
79
+
80
+ The region-aggregation and validation is configured via a project-specific GitHub _
81
+ repository, usually named `https://github.com/iiasa/<project>-workflow `_. Please contact
82
+ the respective project managers or the Scenario Services team if you need access.
83
+
84
+ Executing scenario processing locally
85
+ ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
86
+
87
+ A project workflow can be run on a scenario locally, before submission to an IIASA
88
+ database instance. This can be useful to test region-aggregation and validation.
89
+
90
+ To run the project workflow locally, do the following:
91
+
92
+ 1. Install Python and run ``pip install nomenclature-iamc `` to install the package
93
+ 2. Git-clone the project repository
94
+ (usually `https://github.com/iiasa/<project>-workflow `_)
95
+
96
+ Then, run the workflow on a scenario data file using the terminal (from the folder where
97
+ the project repository was cloned to).
98
+
99
+ .. code ::
100
+
101
+ nomenclature validate-scenario <path-to-scenario-file>.xlsx
102
+
103
+ The output log in the terminal will show any validation errors. If the output is empty,
104
+ the validation was successful.
105
+
106
+ .. warning ::
107
+
108
+ Make sure to pull the latest project repository and update the **nomenclature ** package
109
+ when you repeat this step later to make sure that the IIASA infrastructure and your
110
+ local check are in sync.
111
+
112
+ Read the `User Guide `_ of the **nomenclature ** package for more information!
113
+
114
+ .. _GitHub : https://www.github.com
115
+
116
+ .. _`https://github.com/iiasa/<project>-workflow` : https://github.com/iiasa
117
+
118
+ .. _`User Guide` : https://nomenclature-iamc.readthedocs.io/en/stable/user_guide/local-usage.html
0 commit comments