Skip to end of metadata
Go to start of metadata

Task Overview

Jira task CIDEVEOI-53

Task Stake Holders

  • Developer: Chris Mueller, Tim LaRocque
  • Designer: Chris Mueller, John Graybeal
  • Architect: Michael Meisinger

Short Description

Already indexing time range as metadata fields. Need to add support for geospatial extents. (Data extents not in scope for R1). Must also update existing dataset agents to ensure inclusion of all OOICI required metadata fields.

Architecture and Design Inputs

Other Inputs

  1. Existing agents in the EOI Agents working repository demonstrate adding global attributes to datasets:

Entry Criteria

  • Assumptions:
    • (delete me) List the assumptions applying to this task.
  • Dependencies:
    • N/A

Proposed Task Work Description

Context and Problem description

In order to support proper dataset lookups against the resource system, datasets must contain geospatial extents as header metadata. This way, only dataset headers need to be accessed to match areas of interest to dataset extents. While in this segment of code, it is also appropriate to make necessary updates to existing agents to ensure all OOICI required metadata fields are filled in.

Scoping

Proposed Work Steps

  1. Define a naming convention for dataset attributes to represent geospatial extents
    1. For example, use metadata keys similar to these:
      • geoextent_left
      • geoextent_bottom
      • geoextent_right
      • geoextent_top
  2. Decide the proper procedure for accurately determining a dataset's geospatial extent.
    • This determination should be made against the data retrieved rather than the request for data being processed (results acquired may differ from the request)
    • This procedure could be enacted in an abstracted way such that each agent need not be modified (preferably in the NcdsFactory.java class
  3. Modify each agent by appending conventional attributes so to store geospatial extents according to the aforementioned procedure
  4. Update the OOICI Minimum Metadata page to reflect the new required geospatial attributes
  5. Augment existing agents to ensure compliance with OOICI metadata standards
    1. Determine existing support of metadata fields required by OOICI
    2. Augment agents which provide incomplete or inaccurate metadata

Proposed Task Outcome Description

Outcome Description

  1. Extended Agent capabilities to include global attributes representing geospatial values in data product outputs
  2. Extended Agent capabilities to ensure inclusion of all required OOICI metadata items
  3. Updated OOICI Minimum Metadata to reflect the new required geospatial attributes

Test Cases Required to Succeed


Notes

Implementation

For details on the OOICI "minimum metadata" fields: EOI Dataset Metadata

Decision that the following global attributes will be used to track the geospatial-temporal bounds:

  • ion_time_coverage_start
  • ion_time_coverage_end
  • ion_geospatial_lat_max
  • ion_geospatial_lat_min
  • ion_geospatial_lon_max
  • ion_geospatial_lon_min
  • ion_geospatial_vertical_min
  • ion_geospatial_vertical_max
  • ion_geospatial_vertical_positive

Other dataset metadata (not yet finalized)

  • title
  • institution
  • source
  • history
  • references
  • comment
  • data_url
  • Conventions
Notes on the Geospatiotemporal Bounds Attributes

Temporal
The temporal bounds represent the Begin Date ("ion_time_coverage_start") and End Date ("ion_time_coverage_end") for the dataset. Together they are the temporal extent for the dataset.

Horizontal Geospatial
The horizontal bounds represent the northern ("ion_geospatial_lat_max"), southern ("ion_geospatial_lat_min"), western ("ion_geospatial_lon_min"), and eastern ("ion_geospatial_lon_max") geographic extents of the dataset. The values are always in decimal degrees and the longitude "frame of reference" is -180 to 180.

Vertical Geospatial
The vertical bounds represent the numerical minimum ("ion_geospatial_vertical_min") and maximum ("ion_geospatial_vertical_max") vertical extents of the dataset. The "ion_geospatial_vertical_positive" attribute determines the "direction of increasing numerical value". This can either be "up" or "down". The following diagram helps explain this concept.

Metadata Pathways

Purple boxes contain information on metadata processing

Overview (google doc)

NetCDF Sources (google doc)

"ASCII" Sources (google doc)


Task Documentation on Completion

  • Current support of metadata is documented here

Summary of any key results/important technical findings

Work Result As Implemented

Code Produced
Documentation Produced
Tests Passed

Lessons Learned

Scribbles, Scratch Materials

Enter labels to add to this page:
Please wait 
Looking for a label? Just start typing.