Vector layers on product pages

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 }} <https://doi.org/{{ page.data.doi }}>`_
@@ -522,6 +536,31 @@
    {{ page.tables.bands_footnote if page.tables.bands_footnote }}
    {% endif %}
 
+   {% if layers_table_list %}
+   .. rubric:: Layers
+      :name: layers
+      :class: h2
+
+   This product contains the following layers, and the attribute fields of each are listed.
+
+   {% for layer in layers_table_list %}
+   **Layer: {{ layer.name }}**
+
+   {{ layer.description or no_data_terms.dash }} Attribute fields:
+
+   .. list-table::
+      :name: layers-table
+
+      {% for attribute in layer.attributes %}
+      * - **{{ attribute.name }}**
+        - {{ attribute.description }}
+      {% endfor %}
+   {% endfor %}
+
+   {{ page.tables.layers_footnote if page.tables.layers_footnote }}
+
+   {% endif %}
+
    .. rubric:: Product information
       :name: product-information
       :class: h2

docs/data/product/dea-coastlines/_tables.yaml

@@ -1,14 +1,52 @@
 # 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 bands, 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
+        description: The year of each annual shoreline.
+      - name: certainty
+        description: A column providing important data quality flags for each annual shoreline.  For more information, see the `Quality tab <./?tab=quality>`_.
+      - name: tide_datum
+        description: The tide datum of each annual shoreline (e.g. “0 m AMSL”).
+      - name: id_primary
+        description: The name of the annual shoreline’s Primary sediment compartment from the `Australian Coastal Sediment Compartments <https://ecat.ga.gov.au/geonetwork/srv/api/records/21a23d9a-00dd-ab19-e053-10a3070a2746>`_ 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
+        description: A unique geohash identifier for each point.
+      - name: rate_time
+        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
+        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
+        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
+        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
+        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_std
+        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
+        description: The total number of valid (i.e. non-outliers, non-missing) annual shoreline observations, and the maximum number of years between the first and last valid annual shoreline.
+      - name: valid_span
+        description: The total number of valid (i.e. non-outliers, non-missing) annual shoreline observations, and the maximum number of years between the first and last valid annual shoreline.
+      - name: sce
+        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
+        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
+        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
+        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
+        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
+        description: The name of the annual shoreline’s Primary sediment compartment from the `Australian Coastal Sediment Compartments <https://ecat.ga.gov.au/geonetwork/srv/api/records/21a23d9a-00dd-ab19-e053-10a3070a2746>`_ framework.

starter-kits/product/_tables.yaml

@@ -13,3 +13,13 @@
 #     type: int16
 #     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
+#         description: A description of the attribute.