From ba0b1a044839bd755a180fb9113a1a121a38df68 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Mika=20Pfl=C3=BCger?= Date: Wed, 24 Feb 2021 11:07:44 +0100 Subject: [PATCH 1/2] Fix table with other attributes. --- docs/data_format_details.rst | 10 +++++----- 1 file changed, 5 insertions(+), 5 deletions(-) diff --git a/docs/data_format_details.rst b/docs/data_format_details.rst index 689786cf..bbc37a4c 100644 --- a/docs/data_format_details.rst +++ b/docs/data_format_details.rst @@ -99,17 +99,17 @@ The metadata about the dimensions is described above in the paragraph concerning dimensions. The other attributes with metadata about the dataset as a whole are: -=========== ======================================== ============================================ +=========== ======================================== ========================================= attribute description data type ------------ ---------------------------------------- -------------------------------------------- -references citable reference(s) describing the data ``str`` starting with ``doi:`` or free-form +----------- ---------------------------------------- ----------------------------------------- +references citable reference(s) describing the data free-form ``str`` (ideally URL, e.g. DOI) rights license or other usage restrictions free-form ``str`` -contact who can answer questions about the data usually email address, but free-form ``str`` +contact who can answer questions about the data free-form ``str`` (usually email) title a succinct description free-form ``str`` comment longer form description free-form ``str`` institution where the data originates free-form ``str`` history processing steps done on the data ``str`` with specific rules (see text) -=========== ======================================== ============================================ +=========== ======================================== ========================================= All of these attributes are optional. If the ``references`` field starts with ``doi:``, it is a doi, otherwise it is a From a359c39a419676758f57ae04c8dcecdaafb9d191 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Mika=20Pfl=C3=BCger?= Date: Wed, 24 Feb 2021 11:22:23 +0100 Subject: [PATCH 2/2] Fix dimension table. --- docs/data_format_details.rst | 20 +++++++++++--------- 1 file changed, 11 insertions(+), 9 deletions(-) diff --git a/docs/data_format_details.rst b/docs/data_format_details.rst index bbc37a4c..433c8ac5 100644 --- a/docs/data_format_details.rst +++ b/docs/data_format_details.rst @@ -14,18 +14,18 @@ For all dimensions, defined names have to be used and additional metadata about dimensions is stored in the datasets ``attrs``. The dimensions are: -=============== ===================== ======== ======================================================== =================================== -dimension dimension key required notes attrs ---------------- --------------------- -------- -------------------------------------------------------- ----------------------------------- +=============== ===================== ======== ====================================== ======================================= +dimension dimension key required notes attrs +--------------- --------------------- -------- -------------------------------------- --------------------------------------- time time ✗ for periods, the *start* of the period -area area () ✗ must be a pre-defined category set 'area': 'area ()' -category category () primary category 'cat': 'category ()' -sec. categories () there can be multiple 'sec_cats': [' ()', …] -scenario scenario () 'scen': 'scenario ()' -provenance provenance values are ``measured``, ``projected``, and ``derived`` +area area () ✗ must be a pre-defined category set ``'area': 'area ()'`` +category category () primary category ``'cat': 'category ()'`` +sec. categories () there can be multiple ``'sec_cats': [' ()', …]`` +scenario scenario () ``'scen': 'scenario ()'`` +provenance provenance values from fixed set model model model should be from a predefined list source source ✗ a short source identifier -=============== ===================== ======== ======================================================== =================================== +=============== ===================== ======== ====================================== ======================================= For some dimensions, the meaning of the data is directly visible from the data type (``time`` uses an xarray datetime data type) or the values come from a pre-defined list @@ -51,6 +51,8 @@ category-set (for example, ``animal (FAOSTAT)``). Additional rules: * The size of the ``source`` dimension must be exactly 1. +* The valid values for the ``provenance`` are ``measured``, ``projected``, and + ``derived``. Additional Coordinates ----------------------