Survey Metadata File

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

The fields gspy_version and conventions are automatically generated by GSPy following the current package version in use.

When importing from a YAML file, the content field of the survey group should only contain a statement of that individual group’s content. Then, when exporting a survey DataTree, GSPy combs through the content of all subtree groups beneath the survey and appends them such that the final content as written to file for the survey group reflects the entire contents of the tree. See examples for demonstrations.

 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.13, 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. These metadata fields are entirely up to the user’s discretion. The sections shown here are not required, but are shown to demonstrate the type of information intended and how it should be formatted:

20survey_information:
21    contractor_project_number: 20022
22    contractor: SkyTEM Canada Inc
23    client: U.S. Geological Survey
24    survey_type: EM/Mag
25    survey_area_name: Northeast Wisconsin Bedrock Mapping
26    state: WI
27    country: USA
28    acquisition_start: 20210117
29    acquisition_end: 20210207
30    survey_attributes_units: SI
31
32survey_equipment:
33    aircraft: Eurocopter Astar 350 B3
34    magnetometer: Geometrics G822A, Kroum KMAG4 counter
35    magnetometer_installation: Front of transmitter frame
36    electromagnetic_system: SkyTEM 304M
37    electromagnetic_installation: Rigid transmitter frame 40m beneath helicopter, Receiver coils at rear of transmitter frame 2m vertical offset
38    laser_altimeter_system: MDL ILM 300R (2)
39    laser_altimeter_sample_rate: 0.033 s
40    navigation_system: Real-time differential GPS Trimble Bullet III
41    navigation_sample_rate: 1.0 s
42    acquisition_system: skytem