Release candidate 1.6 (#705)

IAMconsortium · Sep 15, 2022 · 1bf008c · 1bf008c
1 parent d7d9b45
commit 1bf008c
Show file tree

Hide file tree

Showing 4 changed files with 19 additions and 10 deletions.
diff --git a/RELEASE_NOTES.md b/RELEASE_NOTES.md
@@ -1,4 +1,10 @@
-# Next Release
+# Release v1.6.0
+
+## Highlights
+
+- Improved performance for writing data to *xlsx*
+- Support for filtering by model-scenario pairs with an `index` argument
+- Better integration with the IIASA Scenario Explorer database API 
 
 ## Dependency changes
 

diff --git a/doc/source/api/database.rst b/doc/source/api/database.rst
@@ -17,6 +17,8 @@ See `this tutorial <../tutorials/iiasa_dbs.html>`_ for more information.
 
 .. autofunction:: read_iiasa
 
+.. autofunction:: lazy_read_iiasa
+
 Reading UNFCCC inventory data
 -----------------------------
 

diff --git a/doc/source/api/iiasa.rst b/doc/source/api/iiasa.rst
@@ -18,4 +18,7 @@ See `this tutorial <../tutorials/iiasa_dbs.html>`_ for more information.
 .. autofunction:: read_iiasa
    :noindex:
 
+.. autofunction:: lazy_read_iiasa
+   :noindex:
+
 .. autofunction:: set_config
diff --git a/pyam/iiasa.py b/pyam/iiasa.py
@@ -296,8 +296,8 @@ def index(self, default=True, **kwargs):
             If `True`, return *only* the default version of a model/scenario.
             Any model/scenario without a default version is omitted.
             If `False`, returns all versions.
-         kwargs
-            Arguments to filer by *model* and *scenario*, `*` can be used as wildcard
+        kwargs
+            Arguments to filer by *model* and *scenario*, `*` can be used as wildcard.
         """
         cols = ["version"] if default else ["version", "is_default"]
         return self._query_index(default, **kwargs)[META_IDX + cols].set_index(META_IDX)
@@ -575,9 +575,8 @@ def read_iiasa(name, default=True, meta=True, creds=None, base_url=_AUTH_URL, **
     Parameters
     ----------
     name : str
-        A valid name of an IIASA scenario explorer instance,
-        see :attr:`pyam.iiasa.Connection.valid_connections`. Obtain a list of options
-        via pyam.iiasa.Connection().valid_connections.
+        | Name of an IIASA Scenario Explorer database instance.
+        | See :attr:`pyam.iiasa.Connection.valid_connections`.
     default : bool, optional
         Return *only* the default version of each scenario.
         Any (`model`, `scenario`) without a default version is omitted.
@@ -618,9 +617,8 @@ def lazy_read_iiasa(
         The location to test for valid data and save the data if not up-to-date. Must be
         either xls, xlsx or csv.
     name : str
-        A valid name of an IIASA scenario explorer instance,
-        see :attr:`pyam.iiasa.Connection.valid_connections`. Obtain a list of options
-        via pyam.iiasa.Connection().valid_connections.
+        | Name of an IIASA Scenario Explorer database instance.
+        | See :attr:`pyam.iiasa.Connection.valid_connections`.
     default : bool, optional
         Return *only* the default version of each scenario.
         Any (`model`, `scenario`) without a default version is omitted.
@@ -662,7 +660,7 @@ def lazy_read_iiasa(
             logger.info("Database out of date and will be re-downloaded")
     # If we get here, we need to redownload the database
     new_read = read_iiasa(
-        name, meta=True, default=default, creds=None, base_url=_AUTH_URL, **kwargs
+        name, meta=meta, default=default, creds=creds, base_url=base_url, **kwargs
     )
     Path(file).parent.mkdir(parents=True, exist_ok=True)
     if file.suffix == ".csv":