Meta support for model/scenario levels

RELEASE_NOTES.rst

@@ -4,6 +4,18 @@ Next release
 All changes
 -----------
 
+- :pull:`353`: Add meta functionality.
+
+  - :meth:`.Platform.add_model_name` using :meth:`.Backend.add_model_name`
+  - :meth:`.Platform.add_scenario_name` using :meth:`.Backend.add_scenario_name`
+  - :meth:`.Platform.get_model_names` using :meth:`.Backend.get_model_names`
+  - :meth:`.Platform.get_scenario_names` using :meth:`.Backend.get_scenario_names`
+  - :meth:`.Platform.get_meta` using :meth:`.Backend.get_meta`
+  - :meth:`.Platform.set_meta` using :meth:`.Backend.set_meta`
+  - :meth:`.Platform.remove_meta` using :meth:`.Backend.remove_meta`
+  - :meth:`.Scenario.remove_meta` using :meth:`.Backend.remove_meta`
+  - deprecate :meth:`.Scenario.delete_meta`
+
 - :pull:`349`: Avoid modifying indexers dictionary in :meth:`.AttrSeries.sel`.
 - :pull:`343`: Add region/unit parameters to :meth:`.Platform.export_timeseries_data`.
 - :pull:`347`: Preserve dtypes of index columns in :func:`.data_for_quantity`.

doc/README.rst

@@ -28,7 +28,8 @@ There are a number of guides out there, e.g. on docutils_.
 Building the docs locally
 -------------------------
 
-Install the dependencies, above.
+Install the dependencies, above. Repeat the installation steps to be able to
+refer to code that was changed since the initial installation.
 
 From the command line, run::
 

doc/source/api-backend.rst

@@ -93,17 +93,24 @@ Backend API
    .. autosummary::
       :nosignatures:
 
+      add_model_name
+      add_scenario_name
       close_db
       get_auth
       get_doc
       get_log_level
+      get_meta
+      get_model_names
       get_nodes
       get_scenarios
+      get_scenario_names
       get_units
       open_db
       read_file
+      remove_meta
       set_doc
       set_log_level
+      set_meta
       set_node
       set_unit
       write_file
@@ -150,6 +157,7 @@ Backend API
       item_set_elements
       item_index
       list_items
+      remove_meta
       set_meta
 
    Methods related to :class:`message_ix.Scenario`:

doc/source/api.rst

@@ -29,11 +29,24 @@ Platform
       set_log_level
       units
 
-   The methods
-   :meth:`~.base.Backend.open_db`,
-   :meth:`~.base.Backend.close_db`,
-   :meth:`~.base.Backend.get_doc`, and
-   :meth:`~.base.Backend.set_doc` may also be called via Platform.
+   The following backend methods are available via Platform too:
+
+   .. autosummary::
+      backend.base.Backend.add_model_name
+      backend.base.Backend.add_scenario_name
+      backend.base.Backend.close_db
+      backend.base.Backend.get_doc
+      backend.base.Backend.get_meta
+      backend.base.Backend.get_model_names
+      backend.base.Backend.get_scenario_names
+      backend.base.Backend.open_db
+      backend.base.Backend.remove_meta
+      backend.base.Backend.set_doc
+      backend.base.Backend.set_meta
+
+   These methods can be called like normal Platform methods, e.g.::
+
+     $ platform_instance.close_db()
 
 
 TimeSeries