.. role:: red .. role:: blue .. role:: navy Site ==== :navy:`project` ~~~~~~~~~~~~~~~ .. container:: .. table:: :class: tight-table :widths: 45 45 15 +----------------------------------------------+-----------------------------------------------+----------------+ | **project** | **Description** | **Example** | +==============================================+===============================================+================+ | **Required**: :red:`True` | Name of the project | USMTArray | | | | | | **Type**: | | | | | | | | **Units**: None | | | | | | | | | | | | | | | | | | | | | | | | | | | +----------------------------------------------+-----------------------------------------------+----------------+ :navy:`survey` ~~~~~~~~~~~~~~ .. container:: .. table:: :class: tight-table :widths: 45 45 15 +----------------------------------------------+-----------------------------------------------+----------------+ | **survey** | **Description** | **Example** | +==============================================+===============================================+================+ | **Required**: :red:`True` | Name of the survey | MT 2020 | | | | | | **Type**: | | | | | | | | **Units**: None | | | | | | | | | | | | | | | | | | | | | | | | | | | +----------------------------------------------+-----------------------------------------------+----------------+ :navy:`year_collected` ~~~~~~~~~~~~~~~~~~~~~~ .. container:: .. table:: :class: tight-table :widths: 45 45 15 +----------------------------------------------+-----------------------------------------------+----------------+ | **year_collected** | **Description** | **Example** | +==============================================+===============================================+================+ | **Required**: :red:`True` | Year data collected | 2020 | | | | | | **Type**: mt_metadata.common.mttime.MTime | | | | | str | float | int | | | | | **Units**: None | | | | | | | | | | | | | | | | | | | | | | | | | | | +----------------------------------------------+-----------------------------------------------+----------------+ :navy:`country` ~~~~~~~~~~~~~~~ .. container:: .. table:: :class: tight-table :widths: 45 45 15 +----------------------------------------------+-----------------------------------------------+----------------+ | **country** | **Description** | **Example** | +==============================================+===============================================+================+ | **Required**: :blue:`False` | Country where data was collected | USA | | | | | | **Type**: | | | | | | | | **Units**: None | | | | | | | | | | | | | | | | | | | | | | | | | | | +----------------------------------------------+-----------------------------------------------+----------------+ :navy:`id` ~~~~~~~~~~ .. container:: .. table:: :class: tight-table :widths: 45 45 15 +----------------------------------------------+-----------------------------------------------+----------------+ | **id** | **Description** | **Example** | +==============================================+===============================================+================+ | **Required**: :red:`True` | Station ID name. This should be an alpha | MT001 | | | numeric name that is typically 5-6 characters | | | **Type**: | long. Commonly the project name in 2 or 3 | | | | letters and the station number. | | | **Units**: None | | | | | | | | | | | | | | | | | | | | | | | | | | | +----------------------------------------------+-----------------------------------------------+----------------+ :navy:`name` ~~~~~~~~~~~~ .. container:: .. table:: :class: tight-table :widths: 45 45 15 +----------------------------------------------+-----------------------------------------------+----------------+ | **name** | **Description** | **Example** | +==============================================+===============================================+================+ | **Required**: :red:`True` | closest geographic name to the station | "Whitehorse, | | | | YK" | | **Type**: | | | | | | | | **Units**: None | | | | | | | | | | | | | | | | | | | | | | | | | | | +----------------------------------------------+-----------------------------------------------+----------------+ :navy:`acquired_by` ~~~~~~~~~~~~~~~~~~~ .. container:: .. table:: :class: tight-table :widths: 45 45 15 +----------------------------------------------+-----------------------------------------------+----------------+ | **acquired_by** | **Description** | **Example** | +==============================================+===============================================+================+ | **Required**: :red:`True` | Person or group who collected the data | MT Group | | | | | | **Type**: | | | | | | | | **Units**: None | | | | | | | | | | | | | | | | | | | | | | | | | | | +----------------------------------------------+-----------------------------------------------+----------------+ :navy:`start` ~~~~~~~~~~~~~ .. container:: .. table:: :class: tight-table :widths: 45 45 15 +----------------------------------------------+-----------------------------------------------+----------------+ | **start** | **Description** | **Example** | +==============================================+===============================================+================+ | **Required**: :red:`True` | Date time when the data collection started | 2020-01- | | | | 01T12:00:00 | | **Type**: mt_metadata.common.mttime.MTime | | | | | str | float | int | | | | | **Units**: None | | | | | | | | | | | | | | | | | | | | | | | | | | | +----------------------------------------------+-----------------------------------------------+----------------+ :navy:`end` ~~~~~~~~~~~ .. container:: .. table:: :class: tight-table :widths: 45 45 15 +----------------------------------------------+-----------------------------------------------+----------------+ | **end** | **Description** | **Example** | +==============================================+===============================================+================+ | **Required**: :red:`True` | Date time when the data collection ended | 2020-05- | | | | 01T12:00:00 | | **Type**: mt_metadata.common.mttime.MTime | | | | | str | float | int | | | | | **Units**: None | | | | | | | | | | | | | | | | | | | | | | | | | | | +----------------------------------------------+-----------------------------------------------+----------------+ :navy:`run_list` ~~~~~~~~~~~~~~~~ .. container:: .. table:: :class: tight-table :widths: 45 45 15 +----------------------------------------------+-----------------------------------------------+----------------+ | **run_list** | **Description** | **Example** | +==============================================+===============================================+================+ | **Required**: :red:`True` | list of runs recorded by the station. Should | "[ mt001a, | | | be a summary of all runs recorded | mt001b, mt001c | | **Type**: list[str] | None | | ]" | | | | | | **Units**: None | | | | | | | | | | | | | | | | | | | | | | | | | | | +----------------------------------------------+-----------------------------------------------+----------------+ :navy:`data_quality_notes.good_from_period` ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ .. container:: .. table:: :class: tight-table :widths: 45 45 15 +----------------------------------------------+-----------------------------------------------+----------------+ | **data_quality_notes.good_from_period** | **Description** | **Example** | +==============================================+===============================================+================+ | **Required**: :blue:`False` | Data are good for periods larger than this | 0.01 | | | number | | | **Type**: float | None | | | | | | | | **Units**: None | | | | | | | | | | | | | | | | | | | | | | | | | | | +----------------------------------------------+-----------------------------------------------+----------------+ :navy:`data_quality_notes.good_to_period` ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ .. container:: .. table:: :class: tight-table :widths: 45 45 15 +----------------------------------------------+-----------------------------------------------+----------------+ | **data_quality_notes.good_to_period** | **Description** | **Example** | +==============================================+===============================================+================+ | **Required**: :blue:`False` | Data are good for periods smaller than this | 1000 | | | number | | | **Type**: float | None | | | | | | | | **Units**: None | | | | | | | | | | | | | | | | | | | | | | | | | | | +----------------------------------------------+-----------------------------------------------+----------------+ :navy:`data_quality_notes.rating` ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ .. container:: .. table:: :class: tight-table :widths: 45 45 15 +----------------------------------------------+-----------------------------------------------+----------------+ | **data_quality_notes.rating** | **Description** | **Example** | +==============================================+===============================================+================+ | **Required**: :blue:`False` | Rating of the data from 0 to 5 where 5 is the | 4 | | | best and 0 is unrated | | | **Type**: int | None | | | | | | | | **Units**: None | | | | | | | | | | | | | | | | | | | | | | | | | | | +----------------------------------------------+-----------------------------------------------+----------------+ :navy:`data_quality_notes.comments.author` ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ .. container:: .. table:: :class: tight-table :widths: 45 45 15 +----------------------------------------------+-----------------------------------------------+----------------+ | **data_quality_notes.comments.author** | **Description** | **Example** | +==============================================+===============================================+================+ | **Required**: :blue:`False` | person who authored the comment | J. Pedantic | | | | | | **Type**: str | None | | | | | | | | **Units**: None | | | | | | | | | | | | | | | | | | | | | | | | | | | +----------------------------------------------+-----------------------------------------------+----------------+ :navy:`data_quality_notes.comments.time_stamp` ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ .. container:: .. table:: :class: tight-table :widths: 45 45 15 +----------------------------------------------+-----------------------------------------------+----------------+ | **data_quality_notes.comments.time_stamp** | **Description** | **Example** | +==============================================+===============================================+================+ | **Required**: :blue:`False` | Date and time of in UTC of when comment was | 2020-02- | | | made. | 01T09:23:45.453| | **Type**: float | int | numpy.datetime64 | pa| | 670+00:00 | | ndas._libs.tslibs.timestamps.Timest | | | | **Units**: None | | | | | | | | | | | | | | | | | | | | | | | | | | | +----------------------------------------------+-----------------------------------------------+----------------+ :navy:`data_quality_notes.comments.value` ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ .. container:: .. table:: :class: tight-table :widths: 45 45 15 +----------------------------------------------+-----------------------------------------------+----------------+ | **data_quality_notes.comments.value** | **Description** | **Example** | +==============================================+===============================================+================+ | **Required**: :blue:`False` | comment string | failure at | | | | midnight. | | **Type**: str | list | None | | | | | | | | **Units**: None | | | | | | | | | | | | | | | | | | | | | | | | | | | +----------------------------------------------+-----------------------------------------------+----------------+ :navy:`data_quality_warnings.flag` ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ .. container:: .. table:: :class: tight-table :widths: 45 45 15 +----------------------------------------------+-----------------------------------------------+----------------+ | **data_quality_warnings.flag** | **Description** | **Example** | +==============================================+===============================================+================+ | **Required**: :blue:`False` | Flag for data quality | 0 | | | | | | **Type**: int | None | | | | | | | | **Units**: None | | | | | | | | | | | | | | | | | | | | | | | | | | | +----------------------------------------------+-----------------------------------------------+----------------+ :navy:`data_quality_warnings.comments.author` ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ .. container:: .. table:: :class: tight-table :widths: 45 45 15 +----------------------------------------------+-----------------------------------------------+----------------+ | **data_quality_warnings.comments.author** | **Description** | **Example** | +==============================================+===============================================+================+ | **Required**: :blue:`False` | person who authored the comment | J. Pedantic | | | | | | **Type**: str | None | | | | | | | | **Units**: None | | | | | | | | | | | | | | | | | | | | | | | | | | | +----------------------------------------------+-----------------------------------------------+----------------+ :navy:`data_quality_warnings.comments.time_stamp` ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ .. container:: .. table:: :class: tight-table :widths: 45 45 15 +----------------------------------------------+-----------------------------------------------+----------------+ | **data_quality_warnings.comments.time_stamp**| **Description** | **Example** | +==============================================+===============================================+================+ | **Required**: :blue:`False` | Date and time of in UTC of when comment was | 2020-02- | | | made. | 01T09:23:45.453| | **Type**: float | int | numpy.datetime64 | pa| | 670+00:00 | | ndas._libs.tslibs.timestamps.Timest | | | | **Units**: None | | | | | | | | | | | | | | | | | | | | | | | | | | | +----------------------------------------------+-----------------------------------------------+----------------+ :navy:`data_quality_warnings.comments.value` ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ .. container:: .. table:: :class: tight-table :widths: 45 45 15 +----------------------------------------------+-----------------------------------------------+----------------+ | **data_quality_warnings.comments.value** | **Description** | **Example** | +==============================================+===============================================+================+ | **Required**: :blue:`False` | comment string | failure at | | | | midnight. | | **Type**: str | list | None | | | | | | | | **Units**: None | | | | | | | | | | | | | | | | | | | | | | | | | | | +----------------------------------------------+-----------------------------------------------+----------------+ :navy:`orientation.angle_to_geographic_north` ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ .. container:: .. table:: :class: tight-table :widths: 45 45 15 +----------------------------------------------+-----------------------------------------------+----------------+ | **orientation.angle_to_geographic_north** | **Description** | **Example** | +==============================================+===============================================+================+ | **Required**: :red:`True` | Angle to geographic north of the station | 0 | | | orientation | | | **Type**: | | | | | | | | **Units**: degrees | | | | | | | | | | | | | | | | | | | | | | | | | | | +----------------------------------------------+-----------------------------------------------+----------------+ :navy:`orientation.layout` ~~~~~~~~~~~~~~~~~~~~~~~~~~ .. container:: .. table:: :class: tight-table :widths: 45 45 15 +----------------------------------------------+-----------------------------------------------+----------------+ | **orientation.layout** | **Description** | **Example** | +==============================================+===============================================+================+ | **Required**: :red:`True` | Orientation of channels relative to each | orthogonal | | | other | | | **Type**: | | | | | | | | **Units**: None | | | | | | | | | | | | | | | | | | | | | | | | | | | +----------------------------------------------+-----------------------------------------------+----------------+ :navy:`location.latitude` ~~~~~~~~~~~~~~~~~~~~~~~~~ .. container:: .. table:: :class: tight-table :widths: 45 45 15 +----------------------------------------------+-----------------------------------------------+----------------+ | **location.latitude** | **Description** | **Example** | +==============================================+===============================================+================+ | **Required**: :blue:`False` | Latitude of the location. | 12.324 | | | | | | **Type**: float | None | | | | | | | | **Units**: degrees | | | | | | | | | | | | | | | | | | | | | | | | | | | +----------------------------------------------+-----------------------------------------------+----------------+ :navy:`location.longitude` ~~~~~~~~~~~~~~~~~~~~~~~~~~ .. container:: .. table:: :class: tight-table :widths: 45 45 15 +----------------------------------------------+-----------------------------------------------+----------------+ | **location.longitude** | **Description** | **Example** | +==============================================+===============================================+================+ | **Required**: :blue:`False` | Longitude of the location. | 12.324 | | | | | | **Type**: float | None | | | | | | | | **Units**: degrees | | | | | | | | | | | | | | | | | | | | | | | | | | | +----------------------------------------------+-----------------------------------------------+----------------+ :navy:`location.elevation` ~~~~~~~~~~~~~~~~~~~~~~~~~~ .. container:: .. table:: :class: tight-table :widths: 45 45 15 +----------------------------------------------+-----------------------------------------------+----------------+ | **location.elevation** | **Description** | **Example** | +==============================================+===============================================+================+ | **Required**: :blue:`False` | Elevation of the location. | 1234.0 | | | | | | **Type**: | | | | | | | | **Units**: meters | | | | | | | | | | | | | | | | | | | | | | | | | | | +----------------------------------------------+-----------------------------------------------+----------------+ :navy:`comments.author` ~~~~~~~~~~~~~~~~~~~~~~~ .. container:: .. table:: :class: tight-table :widths: 45 45 15 +----------------------------------------------+-----------------------------------------------+----------------+ | **comments.author** | **Description** | **Example** | +==============================================+===============================================+================+ | **Required**: :blue:`False` | person who authored the comment | J. Pedantic | | | | | | **Type**: str | None | | | | | | | | **Units**: None | | | | | | | | | | | | | | | | | | | | | | | | | | | +----------------------------------------------+-----------------------------------------------+----------------+ :navy:`comments.time_stamp` ~~~~~~~~~~~~~~~~~~~~~~~~~~~ .. container:: .. table:: :class: tight-table :widths: 45 45 15 +----------------------------------------------+-----------------------------------------------+----------------+ | **comments.time_stamp** | **Description** | **Example** | +==============================================+===============================================+================+ | **Required**: :blue:`False` | Date and time of in UTC of when comment was | 2020-02- | | | made. | 01T09:23:45.453| | **Type**: float | int | numpy.datetime64 | pa| | 670+00:00 | | ndas._libs.tslibs.timestamps.Timest | | | | **Units**: None | | | | | | | | | | | | | | | | | | | | | | | | | | | +----------------------------------------------+-----------------------------------------------+----------------+ :navy:`comments.value` ~~~~~~~~~~~~~~~~~~~~~~ .. container:: .. table:: :class: tight-table :widths: 45 45 15 +----------------------------------------------+-----------------------------------------------+----------------+ | **comments.value** | **Description** | **Example** | +==============================================+===============================================+================+ | **Required**: :blue:`False` | comment string | failure at | | | | midnight. | | **Type**: str | list | None | | | | | | | | **Units**: None | | | | | | | | | | | | | | | | | | | | | | | | | | | +----------------------------------------------+-----------------------------------------------+----------------+