.. role:: red .. role:: blue .. role:: navy Run === :navy:`channels_recorded_auxiliary` ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ .. container:: .. table:: :class: tight-table :widths: 45 45 15 +----------------------------------------------+-----------------------------------------------+----------------+ | **channels_recorded_auxiliary** | **Description** | **Example** | +==============================================+===============================================+================+ | **Required**: :red:`True` | List of auxiliary channels recorded | [T] | | | | | | **Type**: list[str] | | | | | | | | **Units**: None | | | | | | | | | | | | | | | | | | | | | | | | | | | +----------------------------------------------+-----------------------------------------------+----------------+ :navy:`channels_recorded_electric` ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ .. container:: .. table:: :class: tight-table :widths: 45 45 15 +----------------------------------------------+-----------------------------------------------+----------------+ | **channels_recorded_electric** | **Description** | **Example** | +==============================================+===============================================+================+ | **Required**: :red:`True` | List of electric channels recorded | [Ex , Ey] | | | | | | **Type**: list[str] | | | | | | | | **Units**: None | | | | | | | | | | | | | | | | | | | | | | | | | | | +----------------------------------------------+-----------------------------------------------+----------------+ :navy:`channels_recorded_magnetic` ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ .. container:: .. table:: :class: tight-table :widths: 45 45 15 +----------------------------------------------+-----------------------------------------------+----------------+ | **channels_recorded_magnetic** | **Description** | **Example** | +==============================================+===============================================+================+ | **Required**: :red:`True` | List of magnetic channels recorded | [Hx , Hy , Hz] | | | | | | **Type**: list[str] | | | | | | | | **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 for this run. | BBMT | | | | | | **Type**: | | | | | | | | **Units**: None | | | | | | | | | | | | | | | | | | | | | | | | | | | +----------------------------------------------+-----------------------------------------------+----------------+ :navy:`id` ~~~~~~~~~~ .. container:: .. table:: :class: tight-table :widths: 45 45 15 +----------------------------------------------+-----------------------------------------------+----------------+ | **id** | **Description** | **Example** | +==============================================+===============================================+================+ | **Required**: :red:`True` | Run ID should be station name followed by a | 001 | | | number or character. Characters should only | | | **Type**: | be used if the run number is small, if the | | | | run number is high consider using digits with | | | **Units**: None | zeros. For example if you have 100 runs the | | | | run ID could be 001 or {station}001. | | | | | | | | | | | | | | | | | | | | | | +----------------------------------------------+-----------------------------------------------+----------------+ :navy:`sample_rate` ~~~~~~~~~~~~~~~~~~~ .. container:: .. table:: :class: tight-table :widths: 45 45 15 +----------------------------------------------+-----------------------------------------------+----------------+ | **sample_rate** | **Description** | **Example** | +==============================================+===============================================+================+ | **Required**: :red:`True` | Digital sample rate for the run | 100 | | | | | | **Type**: | | | | | | | | **Units**: samples per second | | | | | | | | | | | | | | | | | | | | | | | | | | | +----------------------------------------------+-----------------------------------------------+----------------+ :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:`metadata_by.organization` ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ .. container:: .. table:: :class: tight-table :widths: 45 45 15 +----------------------------------------------+-----------------------------------------------+----------------+ | **metadata_by.organization** | **Description** | **Example** | +==============================================+===============================================+================+ | **Required**: :blue:`False` | Organization full name | mt gurus | | | | | | **Type**: str | None | | | | | | | | **Units**: None | | | | | | | | | | | | | | | | | | | | | | | | | | | +----------------------------------------------+-----------------------------------------------+----------------+ :navy:`metadata_by.email` ~~~~~~~~~~~~~~~~~~~~~~~~~ .. container:: .. table:: :class: tight-table :widths: 45 45 15 +----------------------------------------------+-----------------------------------------------+----------------+ | **metadata_by.email** | **Description** | **Example** | +==============================================+===============================================+================+ | **Required**: :blue:`False` | Email of the contact person | mt.guru@em.org | | | | | | **Type**: pydantic.networks.EmailStr | None | | | | | | | | **Units**: None | | | | | | | | | | | | | | | | | | | | | | | | | | | +----------------------------------------------+-----------------------------------------------+----------------+ :navy:`metadata_by.url` ~~~~~~~~~~~~~~~~~~~~~~~ .. container:: .. table:: :class: tight-table :widths: 45 45 15 +----------------------------------------------+-----------------------------------------------+----------------+ | **metadata_by.url** | **Description** | **Example** | +==============================================+===============================================+================+ | **Required**: :blue:`False` | URL of the contact person | https://em.org | | | | | | **Type**: pydantic.networks.AnyUrl | None | | | | | str | | | | **Units**: None | | | | | | | | | | | | | | | | | | | | | | | | | | | +----------------------------------------------+-----------------------------------------------+----------------+ :navy:`metadata_by.comments.author` ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ .. container:: .. table:: :class: tight-table :widths: 45 45 15 +----------------------------------------------+-----------------------------------------------+----------------+ | **metadata_by.comments.author** | **Description** | **Example** | +==============================================+===============================================+================+ | **Required**: :blue:`False` | person who authored the comment | J. Pedantic | | | | | | **Type**: str | None | | | | | | | | **Units**: None | | | | | | | | | | | | | | | | | | | | | | | | | | | +----------------------------------------------+-----------------------------------------------+----------------+ :navy:`metadata_by.comments.time_stamp` ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ .. container:: .. table:: :class: tight-table :widths: 45 45 15 +----------------------------------------------+-----------------------------------------------+----------------+ | **metadata_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:`metadata_by.comments.value` ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ .. container:: .. table:: :class: tight-table :widths: 45 45 15 +----------------------------------------------+-----------------------------------------------+----------------+ | **metadata_by.comments.value** | **Description** | **Example** | +==============================================+===============================================+================+ | **Required**: :blue:`False` | comment string | failure at | | | | midnight. | | **Type**: str | list | None | | | | | | | | **Units**: None | | | | | | | | | | | | | | | | | | | | | | | | | | | +----------------------------------------------+-----------------------------------------------+----------------+ :navy:`metadata_by.author` ~~~~~~~~~~~~~~~~~~~~~~~~~~ .. container:: .. table:: :class: tight-table :widths: 45 45 15 +----------------------------------------------+-----------------------------------------------+----------------+ | **metadata_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:`data_logger.id` ~~~~~~~~~~~~~~~~~~~~~~ .. container:: .. table:: :class: tight-table :widths: 45 45 15 +----------------------------------------------+-----------------------------------------------+----------------+ | **data_logger.id** | **Description** | **Example** | +==============================================+===============================================+================+ | **Required**: :blue:`False` | Instrument ID number can be serial number or | mt01 | | | a designated ID. | | | **Type**: str | None | | | | | | | | **Units**: None | | | | | | | | | | | | | | | | | | | | | | | | | | | +----------------------------------------------+-----------------------------------------------+----------------+ :navy:`data_logger.manufacturer` ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ .. container:: .. table:: :class: tight-table :widths: 45 45 15 +----------------------------------------------+-----------------------------------------------+----------------+ | **data_logger.manufacturer** | **Description** | **Example** | +==============================================+===============================================+================+ | **Required**: :blue:`False` | Who manufactured the instrument. | mt gurus | | | | | | **Type**: str | None | | | | | | | | **Units**: None | | | | | | | | | | | | | | | | | | | | | | | | | | | +----------------------------------------------+-----------------------------------------------+----------------+ :navy:`data_logger.type` ~~~~~~~~~~~~~~~~~~~~~~~~ .. container:: .. table:: :class: tight-table :widths: 45 45 15 +----------------------------------------------+-----------------------------------------------+----------------+ | **data_logger.type** | **Description** | **Example** | +==============================================+===============================================+================+ | **Required**: :blue:`False` | Description of the instrument type. | broadband | | | | 32-bit | | **Type**: str | None | | | | | | | | **Units**: None | | | | | | | | | | | | | | | | | | | | | | | | | | | +----------------------------------------------+-----------------------------------------------+----------------+ :navy:`data_logger.model` ~~~~~~~~~~~~~~~~~~~~~~~~~ .. container:: .. table:: :class: tight-table :widths: 45 45 15 +----------------------------------------------+-----------------------------------------------+----------------+ | **data_logger.model** | **Description** | **Example** | +==============================================+===============================================+================+ | **Required**: :blue:`False` | Model version of the instrument. | falcon5 | | | | | | **Type**: str | None | | | | | | | | **Units**: None | | | | | | | | | | | | | | | | | | | | | | | | | | | +----------------------------------------------+-----------------------------------------------+----------------+ :navy:`data_logger.name` ~~~~~~~~~~~~~~~~~~~~~~~~ .. container:: .. table:: :class: tight-table :widths: 45 45 15 +----------------------------------------------+-----------------------------------------------+----------------+ | **data_logger.name** | **Description** | **Example** | +==============================================+===============================================+================+ | **Required**: :blue:`False` | Standard marketing name of the instrument. | falcon5 | | | | | | **Type**: str | None | | | | | | | | **Units**: None | | | | | | | | | | | | | | | | | | | | | | | | | | | +----------------------------------------------+-----------------------------------------------+----------------+ :navy:`data_logger.timing_system.comments.author` ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ .. container:: .. table:: :class: tight-table :widths: 45 45 15 +----------------------------------------------+-----------------------------------------------+----------------+ | **data_logger.timing_system.comments.author**| **Description** | **Example** | +==============================================+===============================================+================+ | **Required**: :blue:`False` | person who authored the comment | J. Pedantic | | | | | | **Type**: str | None | | | | | | | | **Units**: None | | | | | | | | | | | | | | | | | | | | | | | | | | | +----------------------------------------------+-----------------------------------------------+----------------+ :navy:`data_logger.timing_system.comments.time_stamp` ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ .. container:: .. table:: :class: tight-table :widths: 51 45 15 +----------------------------------------------------+-----------------------------------------------+----------------+ | **data_logger.timing_system.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 | | | 670+00:00 | | pandas._libs.tslibs.timestamps.Timestamp | | | | **Units**: None | | | | | | | | | | | | | | | | | | | | | | | | | | | +----------------------------------------------------+-----------------------------------------------+----------------+ :navy:`data_logger.timing_system.comments.value` ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ .. container:: .. table:: :class: tight-table :widths: 45 45 15 +----------------------------------------------+-----------------------------------------------+----------------+ | **data_logger.timing_system.comments.value** | **Description** | **Example** | +==============================================+===============================================+================+ | **Required**: :blue:`False` | comment string | failure at | | | | midnight. | | **Type**: str | list | None | | | | | | | | **Units**: None | | | | | | | | | | | | | | | | | | | | | | | | | | | +----------------------------------------------+-----------------------------------------------+----------------+ :navy:`data_logger.timing_system.drift` ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ .. container:: .. table:: :class: tight-table :widths: 45 45 15 +----------------------------------------------+-----------------------------------------------+----------------+ | **data_logger.timing_system.drift** | **Description** | **Example** | +==============================================+===============================================+================+ | **Required**: :red:`True` | Estimated drift of the timing system. | 0.001 | | | | | | **Type**: | | | | | | | | **Units**: seconds | | | | | | | | | | | | | | | | | | | | | | | | | | | +----------------------------------------------+-----------------------------------------------+----------------+ :navy:`data_logger.timing_system.type` ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ .. container:: .. table:: :class: tight-table :widths: 45 45 15 +----------------------------------------------+-----------------------------------------------+----------------+ | **data_logger.timing_system.type** | **Description** | **Example** | +==============================================+===============================================+================+ | **Required**: :red:`True` | Type of timing system. | GPS | | | | | | **Type**: | | | | | | | | **Units**: None | | | | | | | | | | | | | | | | | | | | | | | | | | | +----------------------------------------------+-----------------------------------------------+----------------+ :navy:`data_logger.timing_system.uncertainty` ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ .. container:: .. table:: :class: tight-table :widths: 45 45 15 +----------------------------------------------+-----------------------------------------------+----------------+ | **data_logger.timing_system.uncertainty** | **Description** | **Example** | +==============================================+===============================================+================+ | **Required**: :red:`True` | Estimated uncertainty of the timing system. | 0.0002 | | | | | | **Type**: | | | | | | | | **Units**: seconds | | | | | | | | | | | | | | | | | | | | | | | | | | | +----------------------------------------------+-----------------------------------------------+----------------+ :navy:`data_logger.timing_system.n_satellites` ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ .. container:: .. table:: :class: tight-table :widths: 45 45 15 +----------------------------------------------+-----------------------------------------------+----------------+ | **data_logger.timing_system.n_satellites** | **Description** | **Example** | +==============================================+===============================================+================+ | **Required**: :blue:`False` | Number of satellites used for timing. | 6 | | | | | | **Type**: int | None | | | | | | | | **Units**: None | | | | | | | | | | | | | | | | | | | | | | | | | | | +----------------------------------------------+-----------------------------------------------+----------------+ :navy:`data_logger.firmware.author` ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ .. container:: .. table:: :class: tight-table :widths: 45 45 15 +----------------------------------------------+-----------------------------------------------+----------------+ | **data_logger.firmware.author** | **Description** | **Example** | +==============================================+===============================================+================+ | **Required**: :red:`True` | Author of the software | Neo | | | | | | **Type**: str | None | | | | | | | | **Units**: None | | | | | | | | | | | | | | | | | | | | | | | | | | | +----------------------------------------------+-----------------------------------------------+----------------+ :navy:`data_logger.firmware.version` ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ .. container:: .. table:: :class: tight-table :widths: 45 45 15 +----------------------------------------------+-----------------------------------------------+----------------+ | **data_logger.firmware.version** | **Description** | **Example** | +==============================================+===============================================+================+ | **Required**: :red:`True` | Software version | 12.01a | | | | | | **Type**: | | | | | | | | **Units**: None | | | | | | | | | | | | | | | | | | | | | | | | | | | +----------------------------------------------+-----------------------------------------------+----------------+ :navy:`data_logger.firmware.last_updated` ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ .. container:: .. table:: :class: tight-table :widths: 45 45 15 +----------------------------------------------+-----------------------------------------------+----------------+ | **data_logger.firmware.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:`data_logger.firmware.name` ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ .. container:: .. table:: :class: tight-table :widths: 45 45 15 +----------------------------------------------+-----------------------------------------------+----------------+ | **data_logger.firmware.name** | **Description** | **Example** | +==============================================+===============================================+================+ | **Required**: :red:`True` | Software name | mtrules | | | | | | **Type**: | | | | | | | | **Units**: None | | | | | | | | | | | | | | | | | | | | | | | | | | | +----------------------------------------------+-----------------------------------------------+----------------+ :navy:`data_logger.power_source.type` ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ .. container:: .. table:: :class: tight-table :widths: 45 45 15 +----------------------------------------------+-----------------------------------------------+----------------+ | **data_logger.power_source.type** | **Description** | **Example** | +==============================================+===============================================+================+ | **Required**: :blue:`False` | Description of battery type. | pb-acid gel | | | | cell | | **Type**: str | None | | | | | | | | **Units**: None | | | | | | | | | | | | | | | | | | | | | | | | | | | +----------------------------------------------+-----------------------------------------------+----------------+ :navy:`data_logger.power_source.id` ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ .. container:: .. table:: :class: tight-table :widths: 45 45 15 +----------------------------------------------+-----------------------------------------------+----------------+ | **data_logger.power_source.id** | **Description** | **Example** | +==============================================+===============================================+================+ | **Required**: :blue:`False` | battery id | battery01 | | | | | | **Type**: str | None | | | | | | | | **Units**: None | | | | | | | | | | | | | | | | | | | | | | | | | | | +----------------------------------------------+-----------------------------------------------+----------------+ :navy:`data_logger.power_source.voltage.start` ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ .. container:: .. table:: :class: tight-table :widths: 45 45 15 +----------------------------------------------+-----------------------------------------------+----------------+ | **data_logger.power_source.voltage.start** | **Description** | **Example** | +==============================================+===============================================+================+ | **Required**: :red:`True` | Starting value. | 1.0 | | | | | | **Type**: | | | | | | | | **Units**: None | | | | | | | | | | | | | | | | | | | | | | | | | | | +----------------------------------------------+-----------------------------------------------+----------------+ :navy:`data_logger.power_source.voltage.end` ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ .. container:: .. table:: :class: tight-table :widths: 45 45 15 +----------------------------------------------+-----------------------------------------------+----------------+ | **data_logger.power_source.voltage.end** | **Description** | **Example** | +==============================================+===============================================+================+ | **Required**: :red:`True` | Ending value of the range. | 1.0 | | | | | | **Type**: | | | | | | | | **Units**: None | | | | | | | | | | | | | | | | | | | | | | | | | | | +----------------------------------------------+-----------------------------------------------+----------------+ :navy:`data_logger.power_source.comments.author` ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ .. container:: .. table:: :class: tight-table :widths: 45 45 15 +----------------------------------------------+-----------------------------------------------+----------------+ | **data_logger.power_source.comments.author** | **Description** | **Example** | +==============================================+===============================================+================+ | **Required**: :blue:`False` | person who authored the comment | J. Pedantic | | | | | | **Type**: str | None | | | | | | | | **Units**: None | | | | | | | | | | | | | | | | | | | | | | | | | | | +----------------------------------------------+-----------------------------------------------+----------------+ :navy:`data_logger.power_source.comments.time_stamp` ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ .. container:: .. table:: :class: tight-table :widths: 50 45 15 +---------------------------------------------------+-----------------------------------------------+----------------+ | **data_logger.power_source.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 | | | 670+00:00 | | pandas._libs.tslibs.timestamps.Timestamp | | | | **Units**: None | | | | | | | | | | | | | | | | | | | | | | | | | | | +---------------------------------------------------+-----------------------------------------------+----------------+ :navy:`data_logger.power_source.comments.value` ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ .. container:: .. table:: :class: tight-table :widths: 45 45 15 +----------------------------------------------+-----------------------------------------------+----------------+ | **data_logger.power_source.comments.value** | **Description** | **Example** | +==============================================+===============================================+================+ | **Required**: :blue:`False` | comment string | failure at | | | | midnight. | | **Type**: str | list | None | | | | | | | | **Units**: None | | | | | | | | | | | | | | | | | | | | | | | | | | | +----------------------------------------------+-----------------------------------------------+----------------+ :navy:`data_logger.data_storage.id` ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ .. container:: .. table:: :class: tight-table :widths: 45 45 15 +----------------------------------------------+-----------------------------------------------+----------------+ | **data_logger.data_storage.id** | **Description** | **Example** | +==============================================+===============================================+================+ | **Required**: :blue:`False` | Instrument ID number can be serial number or | mt01 | | | a designated ID. | | | **Type**: str | None | | | | | | | | **Units**: None | | | | | | | | | | | | | | | | | | | | | | | | | | | +----------------------------------------------+-----------------------------------------------+----------------+ :navy:`data_logger.data_storage.manufacturer` ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ .. container:: .. table:: :class: tight-table :widths: 45 45 15 +----------------------------------------------+-----------------------------------------------+----------------+ | **data_logger.data_storage.manufacturer** | **Description** | **Example** | +==============================================+===============================================+================+ | **Required**: :blue:`False` | Who manufactured the instrument. | mt gurus | | | | | | **Type**: str | None | | | | | | | | **Units**: None | | | | | | | | | | | | | | | | | | | | | | | | | | | +----------------------------------------------+-----------------------------------------------+----------------+ :navy:`data_logger.data_storage.type` ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ .. container:: .. table:: :class: tight-table :widths: 45 45 15 +----------------------------------------------+-----------------------------------------------+----------------+ | **data_logger.data_storage.type** | **Description** | **Example** | +==============================================+===============================================+================+ | **Required**: :blue:`False` | Description of the instrument type. | broadband | | | | 32-bit | | **Type**: str | None | | | | | | | | **Units**: None | | | | | | | | | | | | | | | | | | | | | | | | | | | +----------------------------------------------+-----------------------------------------------+----------------+ :navy:`data_logger.data_storage.model` ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ .. container:: .. table:: :class: tight-table :widths: 45 45 15 +----------------------------------------------+-----------------------------------------------+----------------+ | **data_logger.data_storage.model** | **Description** | **Example** | +==============================================+===============================================+================+ | **Required**: :blue:`False` | Model version of the instrument. | falcon5 | | | | | | **Type**: str | None | | | | | | | | **Units**: None | | | | | | | | | | | | | | | | | | | | | | | | | | | +----------------------------------------------+-----------------------------------------------+----------------+ :navy:`data_logger.data_storage.name` ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ .. container:: .. table:: :class: tight-table :widths: 45 45 15 +----------------------------------------------+-----------------------------------------------+----------------+ | **data_logger.data_storage.name** | **Description** | **Example** | +==============================================+===============================================+================+ | **Required**: :blue:`False` | Standard marketing name of the instrument. | falcon5 | | | | | | **Type**: str | None | | | | | | | | **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:`channels` ~~~~~~~~~~~~~~~~ .. container:: .. table:: :class: tight-table :widths: 45 45 15 +----------------------------------------------+-----------------------------------------------+----------------+ | **channels** | **Description** | **Example** | +==============================================+===============================================+================+ | **Required**: :blue:`False` | ListDict of channel objects collected in this | ListDict(Electr| | | run. | ic(), | | **Type**: mt_metadata.common.list_dict.ListDi| | Magnetic(), | | ct | list | dict | | | Auxiliary()) | | **Units**: None | | | | | | | | | | | | | | | | | | | | | | | | | | | +----------------------------------------------+-----------------------------------------------+----------------+