diff --git a/docs/_static/styles/global/_utilities.scss b/docs/_static/styles/global/_utilities.scss index 0ff2e4b7b..f8b619c67 100644 --- a/docs/_static/styles/global/_utilities.scss +++ b/docs/_static/styles/global/_utilities.scss @@ -3,3 +3,7 @@ overflow-x: auto; border: none !important; } + +.margin-bottom-2em { + margin-bottom: 2em; +} diff --git a/docs/_templates/external-data-v1.rst b/docs/_templates/external-data-v1.rst index 46dc0831c..417c7a618 100644 --- a/docs/_templates/external-data-v1.rst +++ b/docs/_templates/external-data-v1.rst @@ -269,24 +269,28 @@ :header-rows: 1 * - - - Aliases + - Type + - Units - Resolution - CRS - Nodata - - Units - - Type + - Aliases - Description {% for band in valid_bands %} * - **{{ band.name }}** - - {{ band.aliases|join(', ') if band.aliases else none_text }} + - {{ band.type or not_available_text }} + - {{ band.units or none_text }} - {{ band.resolution or not_available_text }} - {{ band.crs or not_available_text }} - {{ band.nodata }} - - {{ band.units or none_text }} - - {{ band.type or not_available_text }} + - {{ band.aliases|join(', ') if band.aliases else none_text }} - {{ band.description or none_text }} {% endfor %} + .. raw:: html + +
+ {{ Specifications.bands.footnotes if Specifications.bands.footnotes }} {% endif %} {% endif %} diff --git a/docs/_templates/product-v2.rst b/docs/_templates/product-v2.rst index 3f9112a51..875678f0a 100644 --- a/docs/_templates/product-v2.rst +++ b/docs/_templates/product-v2.rst @@ -102,6 +102,10 @@ {% set bands_count = bands_table_list | length %} +{% set layers_table_list = page.tables.layers_table | selectattr("name", "!=", None) | list %} + +{% set layers_count = layers_table_list | length %} + {% set page_title = page.data.short_name if page.data.is_latest_version else format_version_number(page.data.version_number) ~ ". " ~ page.data.short_name %} {% set display_title = page.data.short_name if page.data.is_latest_version else page.data.short_name ~ " " ~ format_version_number(page.data.version_number) %} @@ -368,6 +372,16 @@ * - **Bands** - `Single band of data ({{ bands_table_list[0].name }}) <./?tab=specifications>`_ {%- endif %} + {% if layers_table_list and layers_count >= 3 %} + * - **Layers** + - `{{ layers_count }} layers of data ({{ layers_table_list[0].name }}, {{ layers_table_list[1].name }}, and more). View their attribute fields. <./?tab=specifications>`_ + {%- elif layers_table_list and layers_count == 2 %} + * - **Layers** + - `{{ layers_count }} layers of data ({{ layers_table_list[0].name }} and {{ layers_table_list[1].name }}). View their attribute fields. <./?tab=specifications>`_ + {%- elif layers_table_list and layers_count == 1 %} + * - **Layers** + - `Single layer of data ({{ layers_table_list[0].name }}). View attribute fields. <./?tab=specifications>`_ + {%- endif %} {%- if page.data.doi %} * - **DOI** - `{{ page.data.doi }} `_ @@ -486,7 +500,7 @@ :name: bands :class: h2 - Bands are distinct layers of data within a product that can be loaded using the Open Data Cube (on the `DEA Sandbox `_ or `NCI `_) or DEA's `STAC API `_.{{ " Note that the Coordinate Reference System (CRS) of these bands is {}.".format(coordinate_reference_system_term) if coordinate_reference_system_term }}{% if product_ids_list | length > 1 %} Here are the bands of the products: {{ product_ids_list_text }}.{%- elif product_ids_list %} Here are the bands of the product: {{ product_ids_list_text }}.{%- endif %} + Bands are distinct layers of data within a product that can be loaded using the Open Data Cube (on the `DEA Sandbox `_ or `NCI `_) or DEA's `STAC API `_.{{ " Note that the Coordinate Reference System (CRS) of these bands is {}.".format(coordinate_reference_system_term) if coordinate_reference_system_term }} .. _dea_sandbox: https://knowledge.dea.ga.gov.au/guides/setup/Sandbox/sandbox/ .. _nci: https://knowledge.dea.ga.gov.au/guides/setup/NCI/basics/ @@ -495,16 +509,21 @@ .. list-table:: :header-rows: 1 :name: bands-table + :class: margin-bottom-2em * - - - Aliases + - Type + - Units - Resolution - No-data - - Units - - Type + - Aliases - Description {% for band in bands_table_list %} * - **{{ band.name }}** + - {{ band.type or no_data_terms.dash }} + - {{ band.units or no_data_terms.dash }} + - {{ band.resolution if band.resolution or band.resolution == 0 else no_data_terms.dash }} + - {{ band.nodata if band.nodata or band.nodata == 0 else "" }} - {%- if band.aliases %} {%- for alias in band.aliases %} | {{ alias }} @@ -512,16 +531,49 @@ {%- else %} {{ no_data_terms.dash }} {%- endif %} - - {{ band.resolution if band.resolution or band.resolution == 0 else no_data_terms.dash }} - - {{ band.nodata if band.nodata or band.nodata == 0 else "" }} - - {{ band.units or no_data_terms.dash }} - - {{ band.type or no_data_terms.dash }} - {{ band.description or no_data_terms.dash }} {% endfor %} {{ page.tables.bands_footnote if page.tables.bands_footnote }} {% endif %} + {% if layers_table_list %} + .. rubric:: Layers + :name: layers + :class: h2 + + .. raw:: html + +

Vector products contain one or more distinct layers of data, and each layer can contain multiple attribute fields. This product contains the layers {% for layer in layers_table_list %}{%- if loop.last and loop.index > 1 %}, and {% elif loop.index > 1 %}, {% endif -%}{{ layer.name }}{% endfor %}.

+ + {% for layer in layers_table_list %} + .. rubric:: {{ layer.name }} + :name: layer-{{ loop.index }} + :class: h3 + + {{ layer.description or no_data_terms.dash }} + + .. list-table:: + :header-rows: 1 + :name: layers-table + :class: margin-bottom-2em + + * - + - Type + - Units + - Description + {% for attribute in layer.attributes %} + * - **{{ attribute.name }}** + - {{ attribute.type or no_data_terms.dash }} + - {{ attribute.units or no_data_terms.dash }} + - {{ attribute.description }} + {% endfor %} + {% endfor %} + + {{ page.tables.layers_footnote if page.tables.layers_footnote }} + + {% endif %} + .. rubric:: Product information :name: product-information :class: h2 diff --git a/docs/data/product/dea-coastlines/_tables.yaml b/docs/data/product/dea-coastlines/_tables.yaml index a9bb95932..2a52bd5b1 100644 --- a/docs/data/product/dea-coastlines/_tables.yaml +++ b/docs/data/product/dea-coastlines/_tables.yaml @@ -1,14 +1,102 @@ # See the Product metadata fields documentation: https://docs.dev.dea.ga.gov.au/public_services/dea_knowledge_hub/product_metadata_fields.html -# Bands - -# bands_footnote: A footnote underneath the table. - -# bands_table: -# - name: example_band_name -# aliases: [example_alias_1, example_alias_2] -# resolution: 30 m -# nodata: -999 -# units: null -# type: int16 -# description: A description of the band. +# Layers + +layers_footnote: "For more information on these layers, see the `Description tab <./?tab=description>`_." + +layers_table: + - name: shorelines_annual + description: Annual shoreline vectors that represent the median or ‘most representative’ position of the shoreline at approximately 0 m Above Mean Sea Level for each year since 1988. + attributes: + - name: year + type: Integer + units: Date + description: The year of each annual shoreline. + - name: certainty + type: String + units: null + description: A column providing important data quality flags for each annual shoreline. For more information, see the `Quality tab <./?tab=quality>`_. + - name: tide_datum + type: String + units: null + description: The tide datum of each annual shoreline (e.g. “0 m AMSL”). + - name: id_primary + type: String + units: null + description: The name of the annual shoreline’s Primary sediment compartment from the `Australian Coastal Sediment Compartments `_ framework. + + - name: rates_of_change + description: A point dataset providing robust rates of coastal change for every 30 m along Australia’s non-rocky coastlines. + attributes: + - name: uid + type: String + units: null + description: A unique geohash identifier for each point. + - name: rate_time + type: Float + units: Metres per year + description: Annual rates of change (in metres per year) calculated by linearly regressing annual shoreline distances against time (excluding outliers). Negative values indicate retreat and positive values indicate growth. + - name: sig_time + type: Float + units: P-value + description: Significance (p-value) of the linear relationship between annual shoreline distances and time. Small values (e.g. p-value < 0.01 or 0.05) may indicate a coastline is undergoing consistent coastal change through time. + - name: se_time + type: Float + units: Metres + description: Standard error (in metres) of the linear relationship between annual shoreline distances and time. This can be used to generate confidence intervals around the rate of change given by ``rate_time``, e.g. :math:`\text{95% confidence interval} = \text{se_time} \times 1.96` + - name: outl_time + type: String + units: null + description: Individual annual shoreline are noisy estimators of coastline position that can be influenced by environmental conditions (e.g. clouds, breaking waves, sea spray) or modelling issues (e.g. poor tidal modelling results or limited clear satellite observations). To obtain reliable rates of change, outlier shorelines are excluded using a robust Median Absolute Deviation outlier detection algorithm, and recorded in this column. + - name: dist_1990, dist_1991, etc + type: Float + units: Metres + description: Annual shoreline distances (in metres) relative to the most recent baseline shoreline. Negative values indicate that an annual shoreline was located inland of the baseline shoreline. By definition, the most recent baseline column will always have a distance of 0 m. + - name: angle_mean, angle_std + type: Integer + units: Degrees + description: The mean angle and standard deviation between the baseline point to all annual shorelines. This data is used to calculate how well shorelines fall along a consistent line; high angular standard deviation indicates that derived rates of change are unlikely to be correct. + - name: valid_obs + type: Integer + units: null + description: The total number of valid (i.e. non-outliers, non-missing) annual shoreline observations. + - name: valid_span + type: Integer + units: Years + description: The maximum number of years between the first and last valid annual shoreline. + - name: sce + type: Float + units: Metres + description: Shoreline Change Envelope (SCE). A measure of the maximum change or variability across all annual shorelines, calculated by computing the maximum distance between any two annual shorelines (excluding outliers). This statistic excludes sub-annual shoreline variability. + - name: nsm + type: Float + units: Metres + description: Net Shoreline Movement (NSM). The distance between the oldest (1988) and most recent annual shoreline (excluding outliers). Negative values indicate the coastline retreated between the oldest and most recent shoreline; positive values indicate growth. This statistic does not reflect sub-annual shoreline variability, so will underestimate the full extent of variability at any given location. + - name: max_year + type: Integer + units: Date + description: The year that annual shorelines were at their maximum (i.e. located furthest towards the ocean), excluding outliers. This statistic excludes sub-annual shoreline variability. + - name: min_year + type: Integer + units: Date + description: The year that annual shorelines were at their minimum (i.e. located furthest inland), excluding outliers. This statistic excludes sub-annual shoreline variability. + - name: certainty + type: String + units: null + description: A column providing important data quality flags for each point in the dataset. For more information, see the `Quality tab <./?tab=quality>`_. + - name: id_primary + type: String + units: null + description: The name of the point’s Primary sediment compartment from the `Australian Coastal Sediment Compartments `_ framework. + + - name: hotspots_zoom_1, hotspots_zoom_2, and hotspots_zoom_3 + description: "**These three layers contain all attributes of the 'rates_of_change' layer, plus the following additional attributes.** These 'hotspots zoom' layers summarise coastal change within moving 1 km, 5 km, and 10 km windows along the coastline (using moving window analysis)." + attributes: + - name: radius_m + type: Integer + units: Metres + description: The radius of the moving window used to summarise coastal change around this point. + - name: n + type: Integer + units: null + description: The number of 'rates_of_change' points that were used in the moving window calculation. diff --git a/starter-kits/external-data/_specifications.yaml b/starter-kits/external-data/_specifications.yaml index 690d07d98..b39462325 100644 --- a/starter-kits/external-data/_specifications.yaml +++ b/starter-kits/external-data/_specifications.yaml @@ -4,11 +4,11 @@ bands: footnotes: null bands_table: - name: example_band_name - aliases: [example_alias_1, example_alias_2] + type: int16 + units: null resolution: 30 m crs: Multiple (local UTM) nodata: -999 - units: null - type: int16 + aliases: [example_alias_1, example_alias_2] description: A description of the band. diff --git a/starter-kits/product/_tables.yaml b/starter-kits/product/_tables.yaml index 0a8e33157..b5174534d 100644 --- a/starter-kits/product/_tables.yaml +++ b/starter-kits/product/_tables.yaml @@ -6,10 +6,22 @@ # bands_table: # - name: example_band_name -# aliases: [example_alias_1, example_alias_2] +# type: int16 +# units: Metres # resolution: 30 m # nodata: -999 -# units: Metres -# type: int16 +# aliases: [example_alias_1, example_alias_2] # description: A description of the band. +# Layers + +# layers_footnote: A footnote to display under the layers table. + +# layers_table: +# - name: example_layer_name +# description: A description of the layer. +# attributes: +# - name: example_attribute_name +# type: int16 +# units: Metres +# description: A description of the attribute.