diff --git a/docs/index.rst b/docs/index.rst index 3a550936..10eda757 100644 --- a/docs/index.rst +++ b/docs/index.rst @@ -10,9 +10,9 @@ for standard users as well as Argo experts. .. versionadded:: v0.1.14rc2 - - Rolling out incremental support for 🟢 **bgc** variables 🎉 - - New :ref:`Gallery of notebook examples ` for 🟢 **bgc** variables - - Follow specific install instructions :ref:`here ` for 🟢 **bgc** support + - Rolling out incremental support for **bgc** variables 🎉 + - New :ref:`Gallery of notebook examples ` for **bgc** variables + - Follow specific install instructions :ref:`here ` for **bgc** support - Check out a brief overview of new features on the :ref:`What's New` page diff --git a/docs/install.rst b/docs/install.rst index 0143ab83..0e026f1f 100644 --- a/docs/install.rst +++ b/docs/install.rst @@ -29,14 +29,14 @@ you can also work with the latest version: .. _bgc-install: -Install release with partial 🟢 **bgc** support +Install release with partial **bgc** support ----------------------------------------------- .. versionadded:: v0.1.14rc2 -🟢 **bgc** support is provided as a **release candidate** only. Therefore, it is not available in conda and won't be selected by default with pip. +**bgc** support is provided as a **release candidate** only. Therefore, it is not available in conda and won't be selected by default with pip. -To install **argopy** with *partial* 🟢 **bgc** support, you need to use: +To install **argopy** with *partial* **bgc** support, you need to use: .. code-block:: text diff --git a/docs/metadata_fetching.rst b/docs/metadata_fetching.rst index 1ccbe45c..ab2e870c 100644 --- a/docs/metadata_fetching.rst +++ b/docs/metadata_fetching.rst @@ -174,7 +174,7 @@ And finally the list of methods and properties for **search results**: .. _metadata-index-bgc: -Usage with 🟢 **bgc** index +Usage with **bgc** index """"""""""""""""""""""""""" The **argopy** index store supports the Bio and Synthetic Profile directory files: diff --git a/docs/user-guide/fetching-argo-data/data_set.rst b/docs/user-guide/fetching-argo-data/data_set.rst index 13bd5261..406c485b 100644 --- a/docs/user-guide/fetching-argo-data/data_set.rst +++ b/docs/user-guide/fetching-argo-data/data_set.rst @@ -1,8 +1,8 @@ .. currentmodule:: argopy .. _data-set: -Dataset (🟡+🔵 vs 🟢) -###################### +Dataset +####### |Profile count| |Profile BGC count| @@ -21,9 +21,9 @@ Dataset (🟡+🔵 vs 🟢) But they are several Argo `missions `_ with specific files and parameters that need special handling by **argopy**, namely: -- 🟡 the core Argo Mission: from floats that measure temperature, salinity, pressure down to 2000m, -- 🔵 the `Deep Argo Mission `_: from floats that measure temperature, salinity, pressure down to 6000m, -- 🟢 and the `BGC-Argo Mission `_: from floats that measure temperature, salinity, pressure and oxygen, pH, nitrate, chlorophyll, backscatter, irradiance down to 2000m. +- the core Argo Mission: from floats that measure temperature, salinity, pressure down to 2000m, +- the `Deep Argo Mission `_: from floats that measure temperature, salinity, pressure down to 6000m, +- and the `BGC-Argo Mission `_: from floats that measure temperature, salinity, pressure and oxygen, pH, nitrate, chlorophyll, backscatter, irradiance down to 2000m. Argo dataset available in **argopy** @@ -33,11 +33,11 @@ In **argopy** we simply make the difference between physical and biogeochemical In **argopy** you can thus get access to the following Argo data: -1. 🟡+ 🔵 the **phy** dataset, for *physical* parameters. +1. the **phy** dataset, for *physical* parameters. This dataset provides data from floats that measure temperature, salinity, pressure, without limitation in depth. It is available from all :ref:`Available data sources`. Since this is the most common Argo data subset it's selected with the ``phy`` keyword by default in **argopy**. -2. 🟢 the **bgc** dataset, for *biogeochemical* parameters. +2. the **bgc** dataset, for *biogeochemical* parameters. This dataset provides data from floats that measure temperature, salinity, pressure and oxygen, pH, nitrate, chlorophyll, backscatter, irradiance, without limitation in depth. You can select this dataset with the keyword ``bgc`` and methods described below. @@ -75,7 +75,7 @@ You have several ways to specify which dataset you want to use: In the future, we could consider to add more mission specific keywords for the ``dataset`` option and ``ds`` fetcher argument of :class:`DataFetcher`. This could be *deep* for instance. Please `raise an gitHub "issue" `_ if you may require such a new feature. -The 🟢 **bgc** dataset +The **bgc** dataset ********************** .. role:: python(code) :language: python @@ -84,7 +84,7 @@ The 🟢 **bgc** dataset At this time, BGC parameters are only available in ``expert`` :ref:`user mode ` and with the ``erddap`` :ref:`data source `. -All **argopy** features work with the 🟡+ 🔵 **phy** dataset. However, they are some specific methods dedicated to the 🟢 **bgc** dataset that we now describe. +All **argopy** features work with the **phy** dataset. However, they are some specific methods dedicated to the **bgc** dataset that we now describe. Specifics in :class:`DataFetcher` ================================= diff --git a/docs/user-guide/fetching-argo-data/data_sources.rst b/docs/user-guide/fetching-argo-data/data_sources.rst index 650f076b..fdb86c5a 100644 --- a/docs/user-guide/fetching-argo-data/data_sources.rst +++ b/docs/user-guide/fetching-argo-data/data_sources.rst @@ -147,27 +147,27 @@ capabilities. Here is a summary: - - * - - - 🟡 core (T/S) + - core (T/S) - X - X - X * - - - 🟢 BGC + - BGC - X - X - * - - - 🔵 Deep + - Deep - X - X - X * - - - ⚫ Trajectories + - Trajectories - - - * - - - 🟣 Reference data for DMQC + - Reference data for DMQC - X - - diff --git a/docs/user-guide/fetching-argo-data/user_mode.rst b/docs/user-guide/fetching-argo-data/user_mode.rst index 32ef7289..fa1df7b8 100644 --- a/docs/user-guide/fetching-argo-data/user_mode.rst +++ b/docs/user-guide/fetching-argo-data/user_mode.rst @@ -84,7 +84,7 @@ The **research** mode is the safer choice, with data of the highest quality, car - all without jargon (DATA_MODE and QC_FLAG are retained) - comprehensive minimum -.. admonition:: About the 🟢 **bgc** dataset +.. admonition:: About the **bgc** dataset The table of **argopy** user mode data processing details for **biogeochemical** parameters is being defined (:issue:`280`) and will be implemented in a near future release. diff --git a/docs/user-guide/working-with-argo-data/visualisation.rst b/docs/user-guide/working-with-argo-data/visualisation.rst index ac37faa4..d07a24e1 100644 --- a/docs/user-guide/working-with-argo-data/visualisation.rst +++ b/docs/user-guide/working-with-argo-data/visualisation.rst @@ -111,7 +111,7 @@ Examples: .. image:: ../../_static/dashboard_profile.png - .. tab:: For 🟢 **bgc** profiles + .. tab:: For **bgc** profiles and for a BGC float, change the ``type`` option to ``bgc``: diff --git a/docs/whats-new.rst b/docs/whats-new.rst index 623cfa95..427bd7f1 100644 --- a/docs/whats-new.rst +++ b/docs/whats-new.rst @@ -10,6 +10,9 @@ What's New Coming up next -------------- +**Features and front-end API** + +- Rolling out incremental support for BGC variables 🎉 All new features from v0.1.14rc2 and v0.1.14rc1 ! See below ... **Internals** @@ -84,7 +87,7 @@ v0.1.14rc2 (27 Jul. 2023) - Refactor pickle files in argopy/assets as json files in argopy/static/assets -- Refactor list of variables by data types used in :func:`utils.cast_Argo_variable_type` into assets json files in argopy/static/assets +- Refactor list of variables by data types used in :func:`related.cast_Argo_variable_type` into assets json files in argopy/static/assets - Change of behaviour: when setting the cachedir option, path it's not tested for existence but for being writable, and is created if doesn't exists (but seems to break CI upstream in Windows) @@ -147,7 +150,7 @@ v0.1.14rc1 (31 May 2023) .. 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``. +- New option to control the expiration time of cache file: ``cache_expiration``. **Internals**