From 46a04b0a1117b74f677443b685a91df47d4fe236 Mon Sep 17 00:00:00 2001 From: Guillaume Maze Date: Wed, 31 May 2023 10:11:55 +0200 Subject: [PATCH] Misc doc update before release [skip-ci] --- argopy/utilities.py | 4 ++-- docs/metadata_fetching.rst | 6 +++--- docs/whats-new.rst | 10 +++++++--- 3 files changed, 12 insertions(+), 8 deletions(-) diff --git a/argopy/utilities.py b/argopy/utilities.py index 3449eaae..c180fde7 100644 --- a/argopy/utilities.py +++ b/argopy/utilities.py @@ -2887,10 +2887,10 @@ class ArgoNVSReferenceTables: -------- >>> R = ArgoNVSReferenceTables() >>> R.valid_ref - >>> R.all_tbl_name() + >>> R.all_tbl_name + >>> R.all_tbl >>> R.tbl(3) >>> R.tbl('R09') - >>> R.all_tbl() """ valid_ref = [ diff --git a/docs/metadata_fetching.rst b/docs/metadata_fetching.rst index b20b7ffb..817010d8 100644 --- a/docs/metadata_fetching.rst +++ b/docs/metadata_fetching.rst @@ -222,12 +222,12 @@ The reference table is returned as a :class:`pandas.DataFrame`. If you want the NVS.tbl_name('R01') -On the other hand, if you want to retrieve all reference tables, you can do it with the :meth:`ArgoNVSReferenceTables.all_tbl` method. It will return a dictionary with table short names as key and :class:`pandas.DataFrame` as values. +If you're looking the ID to use for a specific reference table, you can check it from the list of all available tables given by the :meth:`ArgoNVSReferenceTables.all_tbl_name` property. It will return a dictionary with table IDs as key and table name, definition and NVS link as values. Use the :meth:`ArgoNVSReferenceTables.all_tbl` property to retrieve all tables. .. ipython:: python - all = NVS.all_tbl() - all.keys() + NVS.all_tbl_name + Deployment Plan --------------- diff --git a/docs/whats-new.rst b/docs/whats-new.rst index 82dec7df..b83489a0 100644 --- a/docs/whats-new.rst +++ b/docs/whats-new.rst @@ -7,7 +7,7 @@ What's New |pypi dwn| |conda dwn| -v0.1.14rc1 (30 May 2023) +v0.1.14rc1 (31 May 2023) ------------------------ **Features and front-end API** @@ -34,14 +34,14 @@ v0.1.14rc1 (30 May 2023) - **New 'research' user mode**. This new feature implements automatic filtering of Argo data following international recommendations for research/climate studies. With this user mode, only Delayed Mode with good QC data are returned. Check out the :ref:`user-mode` section for all the details. (:pr:`265`) by `G. Maze `_ -- **argopy now provides a specific xarray engine to properly read Argo netcdf files**. Using ``engine='argo'`` in :func:`xarray.open_dataset`, all variables will properly be casted, i.e. returned with their expected data types, which is not the case otherwise. This works with *ALL* Argo netcdf file types (as listed in the `Reference table R01 `_). (:pr:`208`) by `G. Maze `_ +- **argopy now provides a specific xarray engine to properly read Argo netcdf files**. Using ``engine='argo'`` in :func:`xarray.open_dataset`, all variables will properly be casted, i.e. returned with their expected data types, which is not the case otherwise. This works with *ALL* Argo netcdf file types (as listed in the `Reference table R01 `_). Some details in here: :class:`argopy.xarray.ArgoEngine` (:pr:`208`) by `G. Maze `_ .. code-block:: python import xarray as xr ds = xr.open_dataset("dac/aoml/1901393/1901393_prof.nc", engine='argo') -- **argopy now provides authenticated access to the Argo reference database for DMQC**. Using user/password new **argopy** options, it is now possible to fetch the `Argo CTD reference database `_, with the :class:`CTDRefDataFetcher` class. (:pr:`256`) by `G. Maze `_ +- **argopy now can provide authenticated access to the Argo CTD reference database for DMQC**. Using user/password new **argopy** options, it is possible to fetch the `Argo CTD reference database `_, with the :class:`CTDRefDataFetcher` class. (:pr:`256`) by `G. Maze `_ .. code-block:: python @@ -51,6 +51,9 @@ v0.1.14rc1 (30 May 2023) f = CTDRefDataFetcher(box=[15, 30, -70, -60, 0, 5000.0]) ds = f.to_xarray() +.. warning:: + **argopy** is ready but the Argo CTD reference database for DMQC is not fully published on the Ifremer ERDDAP yet. This new feature will thus be fully operational soon, and while it's not, **argopy** should raise an ``ErddapHTTPNotFound`` error when using the new fetcher. + - New option to control the expiration time of cache file ``cache_expiration``. **Internals** @@ -91,6 +94,7 @@ v0.1.14rc1 (30 May 2023) **Breaking changes** - The legacy index store is deprecated, now available in argopy.stores.argo_index_deprec.py only (:pr:`270`) by `G. Maze `_ +- The :meth:`ArgoNVSReferenceTables.all_tbl` and :meth:`ArgoNVSReferenceTables.all_tbl_name` methods are now properties, hence no longer callable. v0.1.13 (28 Mar. 2023)