Metadata Files

Let’s breakdown the different parts of the metadata files

Survey Metadata

Global attributes for the Survey group are passed through the dataset attributes, dataset_attrs dictionary. The fields below are required attributes. Additional fields are welcome at the user’s discretion. See CF conventions for full description of these fields.

 1dataset_attrs:
 2    title: descriptive title for the survey and its data
 3    institution: who owns and produced this data
 4    source:  where did the data come from
 5    history: summarized history of the process steps
 6    references: citation
 7    comment: miscellaneous information 
 8    summary: abstract
 9    content: brief summary of file contents (list all the groups and what they contain)
10    created_by: gspy==2.2.8
11    conventions: CF-1.8, GS-2.0

Coordinate reference system (CRS) information is passed through the spatial_ref dictionary. GSPy requires at least one of the following fields to generates the complete spatial_ref coordinate variable with all necessary fields to accurately plot in GIS software.

12spatial_ref:
13    wkid: well-known id number, such as 4326
14    authority: authority for the wkid, such as EPSG
15    crs_wkt: coordinate reference system well-known text
16    proj_string: projection string
17    prj_file: full path to projection file
18    vertical_crs: optional, vertical reference system

Additional global metadata that pertains to the Survey and all the datasets it will contain can be added as discrete dictionaries:

20survey_equipment:
21    aircraft: Eurocopter Astar 350 B3
22    magnetometer: Geometrics G822A, Kroum KMAG4 counter
23    magnetometer_installation: Front of transmitter frame
24    electromagnetic_system: SkyTEM 304M
25    electromagnetic_installation: Rigid transmitter frame 40m beneath helicopter, Receiver coils at rear of transmitter frame 2m vertical offset
26    spectrometer_system: n/a
27    spectrometer_installation: n/a
28    spectrometer_sample_rate: n/a
29    radar_altimeter_system: n/a
30    radar_altimeter_sample_rate: n/a
31    laser_altimeter_system: MDL ILM 300R (2)
32    laser_altimeter_sample_rate: 0.033 s
33    inclinometer_system: n/a
34    inclinometer_sample_rate: n/a
35    navigation_system: Real-time differential GPS Trimble Bullet III
36    navigation_sample_rate: 1.0 s
37    acquisition_system: skytem