Skip to content

Latest commit

 

History

History
70 lines (50 loc) · 3.06 KB

scenario-databases.rst

File metadata and controls

70 lines (50 loc) · 3.06 KB
Raw

Scenario databases hosted by IIASA

The Energy, Climate and Environment program (ECE) at IIASA is hosting many databases for the community to facilitate scenario analysis, model comparison and dissemination.

Access and permission management

There are public and project-internal (private) databases. Access to project-internal instances is managed via the Scenario Services Manager. To participate in a project, please create an account and send the username to the project managers by email.

You can see all public and private database instances to which you have access, including your view/submit/edit permissions, in the Services tab of the manager.

_static/ece-manager-screenshot.png

Screenshot of the "Overview" page of the Scenario Services Manager

Model registration

To participate in a model comparison project using the IIASA scenario database infrastructure, you have to "register" your model. A model registration requires three specifications:

  • A model name including a version number, preferably using semantic versioning
  • A list or mapping of region names as they will be submitted (uploaded) to an IIASA database instance by the modeling team, and how the region names should appear in the processed scenario data
  • A model mapping to perform region aggregation from native_regions to common_regions and renaming of model native regions (optional)

Option 1) Registration using an Excel template

If you do not feel comfortable using GitHub, please use the Excel template and send it to the project managers by email.

Option 2) Registration using a GitHub pull request

The preferred approach for model registration is starting a GitHub pull request. Please contact the administrators if permissions for the project repository are required.

Please follow the Model registration user guide.

Scenario version management

When submitting a scenario (a.k.a. "run") to an IIASA database instance with an already existing model-scenario combination, the database will save the new submission as a new version of that run. The version number is incremented automatically and the new version will be automatically set as default version for that model-scenario name.

To select other (non-default) versions, you can use the "Switch to Advanced View" button in the scenario-selection tab of an IIASA Scenario Explorer or you can use the default_only=False option of the function :func:`pyam.read_iiasa()` or the ixmp4 package (read the docs).