.. role:: red .. role:: blue .. role:: navy Station ======= :navy:`channel_layout` ~~~~~~~~~~~~~~~~~~~~~~ .. container:: .. table:: :class: tight-table :widths: 45 45 15 +----------------------------------------------+-----------------------------------------------+----------------+ | **channel_layout** | **Description** | **Example** | +==============================================+===============================================+================+ | **Required**: :blue:`False` | How the station channels were laid out. | X | | | | | | **Type**: | | | | | | | | **Units**: None | | | | | | | | | | | | | | | | | | | | | | | | | | | +----------------------------------------------+-----------------------------------------------+----------------+ :navy:`channels_recorded` ~~~~~~~~~~~~~~~~~~~~~~~~~ .. container:: .. table:: :class: tight-table :widths: 45 45 15 +----------------------------------------------+-----------------------------------------------+----------------+ | **channels_recorded** | **Description** | **Example** | +==============================================+===============================================+================+ | **Required**: :red:`True` | List of components recorded by the station. | "[ Ex, Ey, Hx, | | | Should be a summary of all channels recorded. | Hy, Hz, T]" | | **Type**: list[str] | Dropped channels will be recorded in Run | | | | metadata. | | | **Units**: None | | | | | | | | | | | | | | | | | | | | | | | | | | | +----------------------------------------------+-----------------------------------------------+----------------+ :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 | | | | | | | | | | | | | | | | | | | | | | | | | | | +----------------------------------------------+-----------------------------------------------+----------------+ :navy:`data_type` ~~~~~~~~~~~~~~~~~ .. container:: .. table:: :class: tight-table :widths: 45 45 15 +----------------------------------------------+-----------------------------------------------+----------------+ | **data_type** | **Description** | **Example** | +==============================================+===============================================+================+ | **Required**: :red:`True` | Type of data recorded. If multiple types | BBMT | | | input as a comma separated list. | | | **Type**: | | | | | | | | **Units**: None | | | | | | | | | | | | | | | | | | | | | | | | | | | +----------------------------------------------+-----------------------------------------------+----------------+ :navy:`fdsn.id` ~~~~~~~~~~~~~~~ .. container:: .. table:: :class: tight-table :widths: 45 45 15 +----------------------------------------------+-----------------------------------------------+----------------+ | **fdsn.id** | **Description** | **Example** | +==============================================+===============================================+================+ | **Required**: :blue:`False` | Given FDSN archive ID name. | MT001 | | | | | | **Type**: str | None | | | | | | | | **Units**: None | | | | | | | | | | | | | | | | | | | | | | | | | | | +----------------------------------------------+-----------------------------------------------+----------------+ :navy:`fdsn.network` ~~~~~~~~~~~~~~~~~~~~ .. container:: .. table:: :class: tight-table :widths: 45 45 15 +----------------------------------------------+-----------------------------------------------+----------------+ | **fdsn.network** | **Description** | **Example** | +==============================================+===============================================+================+ | **Required**: :blue:`False` | Given two character FDSN archive network | EM | | | code. Needs to be 2 alpha numeric characters. | | | **Type**: str | None | | | | | | | | **Units**: None | | | | | | | | | | | | | | | | | | | | | | | | | | | +----------------------------------------------+-----------------------------------------------+----------------+ :navy:`fdsn.channel_code` ~~~~~~~~~~~~~~~~~~~~~~~~~ .. container:: .. table:: :class: tight-table :widths: 45 45 15 +----------------------------------------------+-----------------------------------------------+----------------+ | **fdsn.channel_code** | **Description** | **Example** | +==============================================+===============================================+================+ | **Required**: :blue:`False` | Three character FDSN channel code. | LQN | | | http://docs.fdsn.org/projects/source- | | | **Type**: str | None | identifiers/en/v1.0/channel-codes.html | | | | | | | **Units**: None | | | | | | | | | | | | | | | | | | | | | | | | | | | +----------------------------------------------+-----------------------------------------------+----------------+ :navy:`fdsn.new_epoch` ~~~~~~~~~~~~~~~~~~~~~~ .. container:: .. table:: :class: tight-table :widths: 45 45 15 +----------------------------------------------+-----------------------------------------------+----------------+ | **fdsn.new_epoch** | **Description** | **Example** | +==============================================+===============================================+================+ | **Required**: :blue:`False` | Boolean telling if a new epoch needs to be | False | | | created or not. | | | **Type**: bool | None | | | | | | | | **Units**: None | | | | | | | | | | | | | | | | | | | | | | | | | | | +----------------------------------------------+-----------------------------------------------+----------------+ :navy:`fdsn.alternate_code` ~~~~~~~~~~~~~~~~~~~~~~~~~~~ .. container:: .. table:: :class: tight-table :widths: 45 45 15 +----------------------------------------------+-----------------------------------------------+----------------+ | **fdsn.alternate_code** | **Description** | **Example** | +==============================================+===============================================+================+ | **Required**: :blue:`False` | Alternate Code | _INT-NON_FDSN | | | | .UNRESTRICTED | | **Type**: str | None | | _US-ALL _US-MT | | | | _US-MT-TA | | **Units**: None | | | | | | | | | | | | | | | | | | | | | | | | | | | +----------------------------------------------+-----------------------------------------------+----------------+ :navy:`fdsn.alternate_network_code` ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ .. container:: .. table:: :class: tight-table :widths: 45 45 15 +----------------------------------------------+-----------------------------------------------+----------------+ | **fdsn.alternate_network_code** | **Description** | **Example** | +==============================================+===============================================+================+ | **Required**: :blue:`False` | Alternate Network Code | _INT-NON_FDSN | | | | .UNRESTRICTED | | **Type**: str | None | | _US-ALL _US-MT | | | | _US-MT-TA | | **Units**: None | | | | | | | | | | | | | | | | | | | | | | | | | | | +----------------------------------------------+-----------------------------------------------+----------------+ :navy:`geographic_name` ~~~~~~~~~~~~~~~~~~~~~~~ .. container:: .. table:: :class: tight-table :widths: 45 45 15 +----------------------------------------------+-----------------------------------------------+----------------+ | **geographic_name** | **Description** | **Example** | +==============================================+===============================================+================+ | **Required**: :red:`True` | Closest geographic name to the station, | Whitehorse, YK | | | usually a city, but could be another common | | | **Type**: | geographic location. | | | | | | | **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:`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] | | ] | | | | | | **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:`location.datum` ~~~~~~~~~~~~~~~~~~~~~~ .. container:: .. table:: :class: tight-table :widths: 45 45 15 +----------------------------------------------+-----------------------------------------------+----------------+ | **location.datum** | **Description** | **Example** | +==============================================+===============================================+================+ | **Required**: :blue:`False` | Datum of the location values. Usually a well | WGS 84 | | | known datum like WGS84. | | | **Type**: str | int | | | | | | | | **Units**: None | | | | | | | | | | | | | | | | | | | | | | | | | | | +----------------------------------------------+-----------------------------------------------+----------------+ :navy:`location.x` ~~~~~~~~~~~~~~~~~~ .. container:: .. table:: :class: tight-table :widths: 45 45 15 +----------------------------------------------+-----------------------------------------------+----------------+ | **location.x** | **Description** | **Example** | +==============================================+===============================================+================+ | **Required**: :blue:`False` | relative distance to the center of the | 10.0 | | | station | | | **Type**: float | None | | | | | | | | **Units**: meters | | | | | | | | | | | | | | | | | | | | | | | | | | | +----------------------------------------------+-----------------------------------------------+----------------+ :navy:`location.y` ~~~~~~~~~~~~~~~~~~ .. container:: .. table:: :class: tight-table :widths: 45 45 15 +----------------------------------------------+-----------------------------------------------+----------------+ | **location.y** | **Description** | **Example** | +==============================================+===============================================+================+ | **Required**: :blue:`False` | relative distance to the center of the | 10.0 | | | station | | | **Type**: float | None | | | | | | | | **Units**: meters | | | | | | | | | | | | | | | | | | | | | | | | | | | +----------------------------------------------+-----------------------------------------------+----------------+ :navy:`location.z` ~~~~~~~~~~~~~~~~~~ .. container:: .. table:: :class: tight-table :widths: 45 45 15 +----------------------------------------------+-----------------------------------------------+----------------+ | **location.z** | **Description** | **Example** | +==============================================+===============================================+================+ | **Required**: :blue:`False` | relative elevation to the center of the | 10.0 | | | station | | | **Type**: float | None | | | | | | | | **Units**: meters | | | | | | | | | | | | | | | | | | | | | | | | | | | +----------------------------------------------+-----------------------------------------------+----------------+ :navy:`location.latitude_uncertainty` ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ .. container:: .. table:: :class: tight-table :widths: 45 45 15 +----------------------------------------------+-----------------------------------------------+----------------+ | **location.latitude_uncertainty** | **Description** | **Example** | +==============================================+===============================================+================+ | **Required**: :blue:`False` | uncertainty in latitude estimation in degrees | 0.01 | | | | | | **Type**: float | None | | | | | | | | **Units**: degrees | | | | | | | | | | | | | | | | | | | | | | | | | | | +----------------------------------------------+-----------------------------------------------+----------------+ :navy:`location.longitude_uncertainty` ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ .. container:: .. table:: :class: tight-table :widths: 45 45 15 +----------------------------------------------+-----------------------------------------------+----------------+ | **location.longitude_uncertainty** | **Description** | **Example** | +==============================================+===============================================+================+ | **Required**: :blue:`False` | uncertainty in longitude estimation in | 0.01 | | | degrees | | | **Type**: float | None | | | | | | | | **Units**: degrees | | | | | | | | | | | | | | | | | | | | | | | | | | | +----------------------------------------------+-----------------------------------------------+----------------+ :navy:`location.elevation_uncertainty` ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ .. container:: .. table:: :class: tight-table :widths: 45 45 15 +----------------------------------------------+-----------------------------------------------+----------------+ | **location.elevation_uncertainty** | **Description** | **Example** | +==============================================+===============================================+================+ | **Required**: :blue:`False` | uncertainty in elevation estimation | 0.01 | | | | | | **Type**: float | None | | | | | | | | **Units**: meters | | | | | | | | | | | | | | | | | | | | | | | | | | | +----------------------------------------------+-----------------------------------------------+----------------+ :navy:`location.x2` ~~~~~~~~~~~~~~~~~~~ .. container:: .. table:: :class: tight-table :widths: 45 45 15 +----------------------------------------------+-----------------------------------------------+----------------+ | **location.x2** | **Description** | **Example** | +==============================================+===============================================+================+ | **Required**: :blue:`False` | relative distance to the center of the | 10.0 | | | station | | | **Type**: float | None | | | | | | | | **Units**: meters | | | | | | | | | | | | | | | | | | | | | | | | | | | +----------------------------------------------+-----------------------------------------------+----------------+ :navy:`location.y2` ~~~~~~~~~~~~~~~~~~~ .. container:: .. table:: :class: tight-table :widths: 45 45 15 +----------------------------------------------+-----------------------------------------------+----------------+ | **location.y2** | **Description** | **Example** | +==============================================+===============================================+================+ | **Required**: :blue:`False` | relative distance to the center of the | 10.0 | | | station | | | **Type**: float | None | | | | | | | | **Units**: meters | | | | | | | | | | | | | | | | | | | | | | | | | | | +----------------------------------------------+-----------------------------------------------+----------------+ :navy:`location.z2` ~~~~~~~~~~~~~~~~~~~ .. container:: .. table:: :class: tight-table :widths: 45 45 15 +----------------------------------------------+-----------------------------------------------+----------------+ | **location.z2** | **Description** | **Example** | +==============================================+===============================================+================+ | **Required**: :blue:`False` | relative elevation to the center of the | 10.0 | | | station | | | **Type**: float | None | | | | | | | | **Units**: meters | | | | | | | | | | | | | | | | | | | | | | | | | | | +----------------------------------------------+-----------------------------------------------+----------------+ :navy:`location.x_uncertainty` ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ .. container:: .. table:: :class: tight-table :widths: 45 45 15 +----------------------------------------------+-----------------------------------------------+----------------+ | **location.x_uncertainty** | **Description** | **Example** | +==============================================+===============================================+================+ | **Required**: :blue:`False` | uncertainty in longitude estimation in | 0.01 | | | x-direction | | | **Type**: float | None | | | | | | | | **Units**: meters | | | | | | | | | | | | | | | | | | | | | | | | | | | +----------------------------------------------+-----------------------------------------------+----------------+ :navy:`location.y_uncertainty` ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ .. container:: .. table:: :class: tight-table :widths: 45 45 15 +----------------------------------------------+-----------------------------------------------+----------------+ | **location.y_uncertainty** | **Description** | **Example** | +==============================================+===============================================+================+ | **Required**: :blue:`False` | uncertainty in longitude estimation in | 0.01 | | | y-direction | | | **Type**: float | None | | | | | | | | **Units**: meters | | | | | | | | | | | | | | | | | | | | | | | | | | | +----------------------------------------------+-----------------------------------------------+----------------+ :navy:`location.z_uncertainty` ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ .. container:: .. table:: :class: tight-table :widths: 45 45 15 +----------------------------------------------+-----------------------------------------------+----------------+ | **location.z_uncertainty** | **Description** | **Example** | +==============================================+===============================================+================+ | **Required**: :blue:`False` | uncertainty in longitude estimation in | 0.01 | | | z-direction | | | **Type**: float | None | | | | | | | | **Units**: meters | | | | | | | | | | | | | | | | | | | | | | | | | | | +----------------------------------------------+-----------------------------------------------+----------------+ :navy:`location.declination.comments.author` ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ .. container:: .. table:: :class: tight-table :widths: 45 45 15 +----------------------------------------------+-----------------------------------------------+----------------+ | **location.declination.comments.author** | **Description** | **Example** | +==============================================+===============================================+================+ | **Required**: :blue:`False` | person who authored the comment | J. Pedantic | | | | | | **Type**: str | None | | | | | | | | **Units**: None | | | | | | | | | | | | | | | | | | | | | | | | | | | +----------------------------------------------+-----------------------------------------------+----------------+ :navy:`location.declination.comments.time_stamp` ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ .. container:: .. table:: :class: tight-table :widths: 45 45 15 +----------------------------------------------+-----------------------------------------------+----------------+ | **location.declination.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:`location.declination.comments.value` ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ .. container:: .. table:: :class: tight-table :widths: 45 45 15 +----------------------------------------------+-----------------------------------------------+----------------+ | **location.declination.comments.value** | **Description** | **Example** | +==============================================+===============================================+================+ | **Required**: :blue:`False` | comment string | failure at | | | | midnight. | | **Type**: str | list | None | | | | | | | | **Units**: None | | | | | | | | | | | | | | | | | | | | | | | | | | | +----------------------------------------------+-----------------------------------------------+----------------+ :navy:`location.declination.model` ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ .. container:: .. table:: :class: tight-table :widths: 45 45 15 +----------------------------------------------+-----------------------------------------------+----------------+ | **location.declination.model** | **Description** | **Example** | +==============================================+===============================================+================+ | **Required**: :red:`True` | geomagnetic reference model used to calculate | WMM | | | declination | | | **Type**: | | | | | | | | **Units**: None | | | | | | | | | | | | | | | | | | | | | | | | | | | +----------------------------------------------+-----------------------------------------------+----------------+ :navy:`location.declination.epoch` ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ .. container:: .. table:: :class: tight-table :widths: 45 45 15 +----------------------------------------------+-----------------------------------------------+----------------+ | **location.declination.epoch** | **Description** | **Example** | +==============================================+===============================================+================+ | **Required**: :blue:`False` | Epoch for which declination was approximated | 2020 | | | in. | | | **Type**: str | None | | | | | | | | **Units**: None | | | | | | | | | | | | | | | | | | | | | | | | | | | +----------------------------------------------+-----------------------------------------------+----------------+ :navy:`location.declination.value` ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ .. container:: .. table:: :class: tight-table :widths: 45 45 15 +----------------------------------------------+-----------------------------------------------+----------------+ | **location.declination.value** | **Description** | **Example** | +==============================================+===============================================+================+ | **Required**: :red:`True` | declination angle relative to geographic | 12.5 | | | north positive clockwise | | | **Type**: | | | | | | | | **Units**: degrees | | | | | | | | | | | | | | | | | | | | | | | | | | | +----------------------------------------------+-----------------------------------------------+----------------+ :navy:`location.geographic_location.country` ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ .. container:: .. table:: :class: tight-table :widths: 45 45 15 +----------------------------------------------+-----------------------------------------------+----------------+ | **location.geographic_location.country** | **Description** | **Example** | +==============================================+===============================================+================+ | **Required**: :blue:`False` | Country of the geographic location, should be | United States | | | spelled out in full. Can be a list of | of America | | **Type**: str | list[str] | None | countries. | | | | | | | **Units**: None | | | | | | | | | | | | | | | | | | | | | | | | | | | +----------------------------------------------+-----------------------------------------------+----------------+ :navy:`location.geographic_location.state` ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ .. container:: .. table:: :class: tight-table :widths: 45 45 15 +----------------------------------------------+-----------------------------------------------+----------------+ | **location.geographic_location.state** | **Description** | **Example** | +==============================================+===============================================+================+ | **Required**: :blue:`False` | State or province of the geographic location, | [Colorado, | | | should be spelled out in full. Can be a list | Utah] | | **Type**: str | list[str] | None | of states or provinces. | | | | | | | **Units**: None | | | | | | | | | | | | | | | | | | | | | | | | | | | +----------------------------------------------+-----------------------------------------------+----------------+ :navy:`location.geographic_location.county` ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ .. container:: .. table:: :class: tight-table :widths: 45 45 15 +----------------------------------------------+-----------------------------------------------+----------------+ | **location.geographic_location.county** | **Description** | **Example** | +==============================================+===============================================+================+ | **Required**: :blue:`False` | County of the geographic location, should be | [Douglass, | | | spelled out in full. Can be a list of | Fayet] | | **Type**: str | list[str] | None | counties. | | | | | | | **Units**: None | | | | | | | | | | | | | | | | | | | | | | | | | | | +----------------------------------------------+-----------------------------------------------+----------------+ :navy:`location.geographic_location.township` ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ .. container:: .. table:: :class: tight-table :widths: 45 45 15 +----------------------------------------------+-----------------------------------------------+----------------+ | **location.geographic_location.township** | **Description** | **Example** | +==============================================+===============================================+================+ | **Required**: :blue:`False` | Township or city name or code. | 090 | | | | | | **Type**: str | list[str] | None | | | | | | | | **Units**: None | | | | | | | | | | | | | | | | | | | | | | | | | | | +----------------------------------------------+-----------------------------------------------+----------------+ :navy:`location.geographic_location.section` ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ .. container:: .. table:: :class: tight-table :widths: 45 45 15 +----------------------------------------------+-----------------------------------------------+----------------+ | **location.geographic_location.section** | **Description** | **Example** | +==============================================+===============================================+================+ | **Required**: :blue:`False` | Section name or code. | 012 | | | | | | **Type**: str | list[str] | None | | | | | | | | **Units**: None | | | | | | | | | | | | | | | | | | | | | | | | | | | +----------------------------------------------+-----------------------------------------------+----------------+ :navy:`location.geographic_location.quarter` ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ .. container:: .. table:: :class: tight-table :widths: 45 45 15 +----------------------------------------------+-----------------------------------------------+----------------+ | **location.geographic_location.quarter** | **Description** | **Example** | +==============================================+===============================================+================+ | **Required**: :blue:`False` | Quarter section code. | 400 | | | | | | **Type**: str | list[str] | None | | | | | | | | **Units**: None | | | | | | | | | | | | | | | | | | | | | | | | | | | +----------------------------------------------+-----------------------------------------------+----------------+ :navy:`location.geographic_location.parcel` ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ .. container:: .. table:: :class: tight-table :widths: 45 45 15 +----------------------------------------------+-----------------------------------------------+----------------+ | **location.geographic_location.parcel** | **Description** | **Example** | +==============================================+===============================================+================+ | **Required**: :blue:`False` | Land parcel ID. | 46b29a | | | | | | **Type**: str | list[str] | None | | | | | | | | **Units**: None | | | | | | | | | | | | | | | | | | | | | | | | | | | +----------------------------------------------+-----------------------------------------------+----------------+ :navy:`orientation.method` ~~~~~~~~~~~~~~~~~~~~~~~~~~ .. container:: .. table:: :class: tight-table :widths: 45 45 15 +----------------------------------------------+-----------------------------------------------+----------------+ | **orientation.method** | **Description** | **Example** | +==============================================+===============================================+================+ | **Required**: :red:`True` | method for orienting station layout | compass | | | | | | **Type**: | | | | | | | | **Units**: None | | | | | | | | | | | | | | | | | | | | | | | | | | | +----------------------------------------------+-----------------------------------------------+----------------+ :navy:`orientation.reference_frame` ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ .. container:: .. table:: :class: tight-table :widths: 45 45 15 +----------------------------------------------+-----------------------------------------------+----------------+ | **orientation.reference_frame** | **Description** | **Example** | +==============================================+===============================================+================+ | **Required**: :red:`True` | "Reference frame for station layout. There | geomagnetic | | | are only 2 options geographic and | | | **Type**: | coordinate system with North=0 E=90 and | | | **Units**: None | vertical positive downward" | | | | | | | | | | | | | | | | | | | | | | | | | | +----------------------------------------------+-----------------------------------------------+----------------+ :navy:`orientation.angle_to_geographic_north` ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ .. container:: .. table:: :class: tight-table :widths: 45 45 15 +----------------------------------------------+-----------------------------------------------+----------------+ | **orientation.angle_to_geographic_north** | **Description** | **Example** | +==============================================+===============================================+================+ | **Required**: :blue:`False` | "Angle to rotate the data to align with | geomagnetic | | | geographic north. If this number is 0 then it | | | **Type**: float | None | is assumed the data are aligned with | | | | geographic north in a right handed coordinate | | | **Units**: degrees | system." | | | | | | | | | | | | | | | | | | | | | | | | | | +----------------------------------------------+-----------------------------------------------+----------------+ :navy:`orientation.value` ~~~~~~~~~~~~~~~~~~~~~~~~~ .. container:: .. table:: :class: tight-table :widths: 45 45 15 +----------------------------------------------+-----------------------------------------------+----------------+ | **orientation.value** | **Description** | **Example** | +==============================================+===============================================+================+ | **Required**: :blue:`False` | "Channel orientation relative to each other" | orthogonal | | | | | | **Type**: mt_metadata.common.enumerations.Cha| | | | nnelOrientationEnum | None | | | | **Units**: None | | | | | | | | | | | | | | | | | | | | | | | | | | | +----------------------------------------------+-----------------------------------------------+----------------+ :navy:`acquired_by.organization` ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ .. container:: .. table:: :class: tight-table :widths: 45 45 15 +----------------------------------------------+-----------------------------------------------+----------------+ | **acquired_by.organization** | **Description** | **Example** | +==============================================+===============================================+================+ | **Required**: :blue:`False` | Organization full name | mt gurus | | | | | | **Type**: str | None | | | | | | | | **Units**: None | | | | | | | | | | | | | | | | | | | | | | | | | | | +----------------------------------------------+-----------------------------------------------+----------------+ :navy:`acquired_by.email` ~~~~~~~~~~~~~~~~~~~~~~~~~ .. container:: .. table:: :class: tight-table :widths: 45 45 15 +----------------------------------------------+-----------------------------------------------+----------------+ | **acquired_by.email** | **Description** | **Example** | +==============================================+===============================================+================+ | **Required**: :blue:`False` | Email of the contact person | mt.guru@em.org | | | | | | **Type**: pydantic.networks.EmailStr | None | | | | | | | | **Units**: None | | | | | | | | | | | | | | | | | | | | | | | | | | | +----------------------------------------------+-----------------------------------------------+----------------+ :navy:`acquired_by.url` ~~~~~~~~~~~~~~~~~~~~~~~ .. container:: .. table:: :class: tight-table :widths: 45 45 15 +----------------------------------------------+-----------------------------------------------+----------------+ | **acquired_by.url** | **Description** | **Example** | +==============================================+===============================================+================+ | **Required**: :blue:`False` | URL of the contact person | https://em.org | | | | | | **Type**: pydantic.networks.AnyUrl | None | | | | | str | | | | **Units**: None | | | | | | | | | | | | | | | | | | | | | | | | | | | +----------------------------------------------+-----------------------------------------------+----------------+ :navy:`acquired_by.comments.author` ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ .. container:: .. table:: :class: tight-table :widths: 45 45 15 +----------------------------------------------+-----------------------------------------------+----------------+ | **acquired_by.comments.author** | **Description** | **Example** | +==============================================+===============================================+================+ | **Required**: :blue:`False` | person who authored the comment | J. Pedantic | | | | | | **Type**: str | None | | | | | | | | **Units**: None | | | | | | | | | | | | | | | | | | | | | | | | | | | +----------------------------------------------+-----------------------------------------------+----------------+ :navy:`acquired_by.comments.time_stamp` ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ .. container:: .. table:: :class: tight-table :widths: 45 45 15 +----------------------------------------------+-----------------------------------------------+----------------+ | **acquired_by.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:`acquired_by.comments.value` ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ .. container:: .. table:: :class: tight-table :widths: 45 45 15 +----------------------------------------------+-----------------------------------------------+----------------+ | **acquired_by.comments.value** | **Description** | **Example** | +==============================================+===============================================+================+ | **Required**: :blue:`False` | comment string | failure at | | | | midnight. | | **Type**: str | list | None | | | | | | | | **Units**: None | | | | | | | | | | | | | | | | | | | | | | | | | | | +----------------------------------------------+-----------------------------------------------+----------------+ :navy:`acquired_by.author` ~~~~~~~~~~~~~~~~~~~~~~~~~~ .. container:: .. table:: :class: tight-table :widths: 45 45 15 +----------------------------------------------+-----------------------------------------------+----------------+ | **acquired_by.author** | **Description** | **Example** | +==============================================+===============================================+================+ | **Required**: :red:`True` | Persons name, should be full first and last | person name | | | name. | | | **Type**: str | None | | | | | | | | **Units**: None | | | | | | | | | | | | | | | | | | | | | | | | | | | +----------------------------------------------+-----------------------------------------------+----------------+ :navy:`provenance.creation_time` ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ .. container:: .. table:: :class: tight-table :widths: 45 45 15 +----------------------------------------------+-----------------------------------------------+----------------+ | **provenance.creation_time** | **Description** | **Example** | +==============================================+===============================================+================+ | **Required**: :red:`True` | Date and time the file was created. | 2020-02- | | | | 08T12:23:40.324| | **Type**: mt_metadata.common.mttime.MTime | | | 600+00:00 | | str | float | int | | | | | **Units**: None | | | | | | | | | | | | | | | | | | | | | | | | | | | +----------------------------------------------+-----------------------------------------------+----------------+ :navy:`provenance.comments.author` ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ .. container:: .. table:: :class: tight-table :widths: 45 45 15 +----------------------------------------------+-----------------------------------------------+----------------+ | **provenance.comments.author** | **Description** | **Example** | +==============================================+===============================================+================+ | **Required**: :blue:`False` | person who authored the comment | J. Pedantic | | | | | | **Type**: str | None | | | | | | | | **Units**: None | | | | | | | | | | | | | | | | | | | | | | | | | | | +----------------------------------------------+-----------------------------------------------+----------------+ :navy:`provenance.comments.time_stamp` ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ .. container:: .. table:: :class: tight-table :widths: 45 45 15 +----------------------------------------------+-----------------------------------------------+----------------+ | **provenance.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:`provenance.comments.value` ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ .. container:: .. table:: :class: tight-table :widths: 45 45 15 +----------------------------------------------+-----------------------------------------------+----------------+ | **provenance.comments.value** | **Description** | **Example** | +==============================================+===============================================+================+ | **Required**: :blue:`False` | comment string | failure at | | | | midnight. | | **Type**: str | list | None | | | | | | | | **Units**: None | | | | | | | | | | | | | | | | | | | | | | | | | | | +----------------------------------------------+-----------------------------------------------+----------------+ :navy:`provenance.log` ~~~~~~~~~~~~~~~~~~~~~~ .. container:: .. table:: :class: tight-table :widths: 45 45 15 +----------------------------------------------+-----------------------------------------------+----------------+ | **provenance.log** | **Description** | **Example** | +==============================================+===============================================+================+ | **Required**: :blue:`False` | A history of changes made to the data. | 2020-02- | | | | 10T14:24:45+00:| | **Type**: str | None | | 00 updated | | | | metadata | | **Units**: None | | | | | | | | | | | | | | | | | | | | | | | | | | | +----------------------------------------------+-----------------------------------------------+----------------+ :navy:`provenance.creator.organization` ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ .. container:: .. table:: :class: tight-table :widths: 45 45 15 +----------------------------------------------+-----------------------------------------------+----------------+ | **provenance.creator.organization** | **Description** | **Example** | +==============================================+===============================================+================+ | **Required**: :blue:`False` | Organization full name | mt gurus | | | | | | **Type**: str | None | | | | | | | | **Units**: None | | | | | | | | | | | | | | | | | | | | | | | | | | | +----------------------------------------------+-----------------------------------------------+----------------+ :navy:`provenance.creator.email` ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ .. container:: .. table:: :class: tight-table :widths: 45 45 15 +----------------------------------------------+-----------------------------------------------+----------------+ | **provenance.creator.email** | **Description** | **Example** | +==============================================+===============================================+================+ | **Required**: :blue:`False` | Email of the contact person | mt.guru@em.org | | | | | | **Type**: pydantic.networks.EmailStr | None | | | | | | | | **Units**: None | | | | | | | | | | | | | | | | | | | | | | | | | | | +----------------------------------------------+-----------------------------------------------+----------------+ :navy:`provenance.creator.url` ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ .. container:: .. table:: :class: tight-table :widths: 45 45 15 +----------------------------------------------+-----------------------------------------------+----------------+ | **provenance.creator.url** | **Description** | **Example** | +==============================================+===============================================+================+ | **Required**: :blue:`False` | URL of the contact person | https://em.org | | | | | | **Type**: pydantic.networks.AnyUrl | None | | | | | str | | | | **Units**: None | | | | | | | | | | | | | | | | | | | | | | | | | | | +----------------------------------------------+-----------------------------------------------+----------------+ :navy:`provenance.creator.comments.author` ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ .. container:: .. table:: :class: tight-table :widths: 45 45 15 +----------------------------------------------+-----------------------------------------------+----------------+ | **provenance.creator.comments.author** | **Description** | **Example** | +==============================================+===============================================+================+ | **Required**: :blue:`False` | person who authored the comment | J. Pedantic | | | | | | **Type**: str | None | | | | | | | | **Units**: None | | | | | | | | | | | | | | | | | | | | | | | | | | | +----------------------------------------------+-----------------------------------------------+----------------+ :navy:`provenance.creator.comments.time_stamp` ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ .. container:: .. table:: :class: tight-table :widths: 45 45 15 +----------------------------------------------+-----------------------------------------------+----------------+ | **provenance.creator.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:`provenance.creator.comments.value` ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ .. container:: .. table:: :class: tight-table :widths: 45 45 15 +----------------------------------------------+-----------------------------------------------+----------------+ | **provenance.creator.comments.value** | **Description** | **Example** | +==============================================+===============================================+================+ | **Required**: :blue:`False` | comment string | failure at | | | | midnight. | | **Type**: str | list | None | | | | | | | | **Units**: None | | | | | | | | | | | | | | | | | | | | | | | | | | | +----------------------------------------------+-----------------------------------------------+----------------+ :navy:`provenance.creator.author` ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ .. container:: .. table:: :class: tight-table :widths: 45 45 15 +----------------------------------------------+-----------------------------------------------+----------------+ | **provenance.creator.author** | **Description** | **Example** | +==============================================+===============================================+================+ | **Required**: :red:`True` | Persons name, should be full first and last | person name | | | name. | | | **Type**: str | None | | | | | | | | **Units**: None | | | | | | | | | | | | | | | | | | | | | | | | | | | +----------------------------------------------+-----------------------------------------------+----------------+ :navy:`provenance.submitter.organization` ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ .. container:: .. table:: :class: tight-table :widths: 45 45 15 +----------------------------------------------+-----------------------------------------------+----------------+ | **provenance.submitter.organization** | **Description** | **Example** | +==============================================+===============================================+================+ | **Required**: :blue:`False` | Organization full name | mt gurus | | | | | | **Type**: str | None | | | | | | | | **Units**: None | | | | | | | | | | | | | | | | | | | | | | | | | | | +----------------------------------------------+-----------------------------------------------+----------------+ :navy:`provenance.submitter.email` ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ .. container:: .. table:: :class: tight-table :widths: 45 45 15 +----------------------------------------------+-----------------------------------------------+----------------+ | **provenance.submitter.email** | **Description** | **Example** | +==============================================+===============================================+================+ | **Required**: :blue:`False` | Email of the contact person | mt.guru@em.org | | | | | | **Type**: pydantic.networks.EmailStr | None | | | | | | | | **Units**: None | | | | | | | | | | | | | | | | | | | | | | | | | | | +----------------------------------------------+-----------------------------------------------+----------------+ :navy:`provenance.submitter.url` ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ .. container:: .. table:: :class: tight-table :widths: 45 45 15 +----------------------------------------------+-----------------------------------------------+----------------+ | **provenance.submitter.url** | **Description** | **Example** | +==============================================+===============================================+================+ | **Required**: :blue:`False` | URL of the contact person | https://em.org | | | | | | **Type**: pydantic.networks.AnyUrl | None | | | | | str | | | | **Units**: None | | | | | | | | | | | | | | | | | | | | | | | | | | | +----------------------------------------------+-----------------------------------------------+----------------+ :navy:`provenance.submitter.comments.author` ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ .. container:: .. table:: :class: tight-table :widths: 45 45 15 +----------------------------------------------+-----------------------------------------------+----------------+ | **provenance.submitter.comments.author** | **Description** | **Example** | +==============================================+===============================================+================+ | **Required**: :blue:`False` | person who authored the comment | J. Pedantic | | | | | | **Type**: str | None | | | | | | | | **Units**: None | | | | | | | | | | | | | | | | | | | | | | | | | | | +----------------------------------------------+-----------------------------------------------+----------------+ :navy:`provenance.submitter.comments.time_stamp` ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ .. container:: .. table:: :class: tight-table :widths: 45 45 15 +----------------------------------------------+-----------------------------------------------+----------------+ | **provenance.submitter.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:`provenance.submitter.comments.value` ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ .. container:: .. table:: :class: tight-table :widths: 45 45 15 +----------------------------------------------+-----------------------------------------------+----------------+ | **provenance.submitter.comments.value** | **Description** | **Example** | +==============================================+===============================================+================+ | **Required**: :blue:`False` | comment string | failure at | | | | midnight. | | **Type**: str | list | None | | | | | | | | **Units**: None | | | | | | | | | | | | | | | | | | | | | | | | | | | +----------------------------------------------+-----------------------------------------------+----------------+ :navy:`provenance.submitter.author` ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ .. container:: .. table:: :class: tight-table :widths: 45 45 15 +----------------------------------------------+-----------------------------------------------+----------------+ | **provenance.submitter.author** | **Description** | **Example** | +==============================================+===============================================+================+ | **Required**: :red:`True` | Persons name, should be full first and last | person name | | | name. | | | **Type**: str | None | | | | | | | | **Units**: None | | | | | | | | | | | | | | | | | | | | | | | | | | | +----------------------------------------------+-----------------------------------------------+----------------+ :navy:`provenance.archive.organization` ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ .. container:: .. table:: :class: tight-table :widths: 45 45 15 +----------------------------------------------+-----------------------------------------------+----------------+ | **provenance.archive.organization** | **Description** | **Example** | +==============================================+===============================================+================+ | **Required**: :blue:`False` | Organization full name | mt gurus | | | | | | **Type**: str | None | | | | | | | | **Units**: None | | | | | | | | | | | | | | | | | | | | | | | | | | | +----------------------------------------------+-----------------------------------------------+----------------+ :navy:`provenance.archive.email` ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ .. container:: .. table:: :class: tight-table :widths: 45 45 15 +----------------------------------------------+-----------------------------------------------+----------------+ | **provenance.archive.email** | **Description** | **Example** | +==============================================+===============================================+================+ | **Required**: :blue:`False` | Email of the contact person | mt.guru@em.org | | | | | | **Type**: pydantic.networks.EmailStr | None | | | | | | | | **Units**: None | | | | | | | | | | | | | | | | | | | | | | | | | | | +----------------------------------------------+-----------------------------------------------+----------------+ :navy:`provenance.archive.url` ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ .. container:: .. table:: :class: tight-table :widths: 45 45 15 +----------------------------------------------+-----------------------------------------------+----------------+ | **provenance.archive.url** | **Description** | **Example** | +==============================================+===============================================+================+ | **Required**: :blue:`False` | URL of the contact person | https://em.org | | | | | | **Type**: pydantic.networks.AnyUrl | None | | | | | str | | | | **Units**: None | | | | | | | | | | | | | | | | | | | | | | | | | | | +----------------------------------------------+-----------------------------------------------+----------------+ :navy:`provenance.archive.comments.author` ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ .. container:: .. table:: :class: tight-table :widths: 45 45 15 +----------------------------------------------+-----------------------------------------------+----------------+ | **provenance.archive.comments.author** | **Description** | **Example** | +==============================================+===============================================+================+ | **Required**: :blue:`False` | person who authored the comment | J. Pedantic | | | | | | **Type**: str | None | | | | | | | | **Units**: None | | | | | | | | | | | | | | | | | | | | | | | | | | | +----------------------------------------------+-----------------------------------------------+----------------+ :navy:`provenance.archive.comments.time_stamp` ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ .. container:: .. table:: :class: tight-table :widths: 45 45 15 +----------------------------------------------+-----------------------------------------------+----------------+ | **provenance.archive.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:`provenance.archive.comments.value` ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ .. container:: .. table:: :class: tight-table :widths: 45 45 15 +----------------------------------------------+-----------------------------------------------+----------------+ | **provenance.archive.comments.value** | **Description** | **Example** | +==============================================+===============================================+================+ | **Required**: :blue:`False` | comment string | failure at | | | | midnight. | | **Type**: str | list | None | | | | | | | | **Units**: None | | | | | | | | | | | | | | | | | | | | | | | | | | | +----------------------------------------------+-----------------------------------------------+----------------+ :navy:`provenance.archive.name` ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ .. container:: .. table:: :class: tight-table :widths: 45 45 15 +----------------------------------------------+-----------------------------------------------+----------------+ | **provenance.archive.name** | **Description** | **Example** | +==============================================+===============================================+================+ | **Required**: :red:`True` | Persons name, should be full first and last | person name | | | name. | | | **Type**: str | None | | | | | | | | **Units**: None | | | | | | | | | | | | | | | | | | | | | | | | | | | +----------------------------------------------+-----------------------------------------------+----------------+ :navy:`provenance.software.author` ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ .. container:: .. table:: :class: tight-table :widths: 45 45 15 +----------------------------------------------+-----------------------------------------------+----------------+ | **provenance.software.author** | **Description** | **Example** | +==============================================+===============================================+================+ | **Required**: :red:`True` | Author of the software | Neo | | | | | | **Type**: str | None | | | | | | | | **Units**: None | | | | | | | | | | | | | | | | | | | | | | | | | | | +----------------------------------------------+-----------------------------------------------+----------------+ :navy:`provenance.software.version` ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ .. container:: .. table:: :class: tight-table :widths: 45 45 15 +----------------------------------------------+-----------------------------------------------+----------------+ | **provenance.software.version** | **Description** | **Example** | +==============================================+===============================================+================+ | **Required**: :red:`True` | Software version | 12.01a | | | | | | **Type**: | | | | | | | | **Units**: None | | | | | | | | | | | | | | | | | | | | | | | | | | | +----------------------------------------------+-----------------------------------------------+----------------+ :navy:`provenance.software.last_updated` ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ .. container:: .. table:: :class: tight-table :widths: 45 45 15 +----------------------------------------------+-----------------------------------------------+----------------+ | **provenance.software.last_updated** | **Description** | **Example** | +==============================================+===============================================+================+ | **Required**: :blue:`False` | Most recent date the software was updated. | 2020-01-01 | | | Prefer to use version, but this works for | | | **Type**: mt_metadata.common.mttime.MTime | | non-versioned software. | | | str | float | int | | | | | **Units**: None | | | | | | | | | | | | | | | | | | | | | | | | | | | +----------------------------------------------+-----------------------------------------------+----------------+ :navy:`provenance.software.name` ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ .. container:: .. table:: :class: tight-table :widths: 45 45 15 +----------------------------------------------+-----------------------------------------------+----------------+ | **provenance.software.name** | **Description** | **Example** | +==============================================+===============================================+================+ | **Required**: :red:`True` | Software name | mtrules | | | | | | **Type**: | | | | | | | | **Units**: None | | | | | | | | | | | | | | | | | | | | | | | | | | | +----------------------------------------------+-----------------------------------------------+----------------+ :navy:`time_period.end` ~~~~~~~~~~~~~~~~~~~~~~~ .. container:: .. table:: :class: tight-table :widths: 45 45 15 +----------------------------------------------+-----------------------------------------------+----------------+ | **time_period.end** | **Description** | **Example** | +==============================================+===============================================+================+ | **Required**: :red:`True` | End date and time of collection in UTC. | 2020-02- | | | | 04T16:23:45.453| | **Type**: str | float | int | | | 670+00:00 | | numpy.datetime64 | pandas._libs.tsl | | | | **Units**: None | | | | | | | | | | | | | | | | | | | | | | | | | | | +----------------------------------------------+-----------------------------------------------+----------------+ :navy:`time_period.start` ~~~~~~~~~~~~~~~~~~~~~~~~~ .. container:: .. table:: :class: tight-table :widths: 45 45 15 +----------------------------------------------+-----------------------------------------------+----------------+ | **time_period.start** | **Description** | **Example** | +==============================================+===============================================+================+ | **Required**: :red:`True` | Start date and time of collection in UTC. | 2020-02- | | | | 01T09:23:45.453| | **Type**: str | float | int | | | 670+00:00 | | numpy.datetime64 | pandas._libs.tsl | | | | **Units**: None | | | | | | | | | | | | | | | | | | | | | | | | | | | +----------------------------------------------+-----------------------------------------------+----------------+ :navy:`runs` ~~~~~~~~~~~~ .. container:: .. table:: :class: tight-table :widths: 45 45 15 +----------------------------------------------+-----------------------------------------------+----------------+ | **runs** | **Description** | **Example** | +==============================================+===============================================+================+ | **Required**: :blue:`False` | List of runs recorded by the station. | [Run(id='mt001a| | | | '), Run(id='mt0| | **Type**: mt_metadata.common.list_dict.ListDi| | 01b'), Run(id='| | ct | list | dict | | | mt001c')] | | **Units**: None | | | | | | | | | | | | | | | | | | | | | | | | | | | +----------------------------------------------+-----------------------------------------------+----------------+