mt_metadata
===========

.. py:module:: mt_metadata

.. autoapi-nested-parse::

   ==================
   metadata
   ==================

   This module deals with metadata as defined by the MT metadata standards.

   There are multiple containers for each type of metadata, named appropriately.

   Each container will be able to read and write:
       * dictionary
       * json
       * xml
       * csv?
       * pandas.Series
       * anything else?


   Each container has an attribute called _attr_dict which dictates if the
   attribute is included in output objects, the data type, whether it is a
   required parameter, and the style of output.  This should help down the road
   with validation and keeping the data types consistent.  And if things change
   you should only have to changes these dictionaries.

   :copyright:
       Jared Peacock (jpeacock@usgs.gov)

   :license:
       MIT




Submodules
----------

.. toctree::
   :maxdepth: 1

   /source/api/mt_metadata/base/index
   /source/api/mt_metadata/common/index
   /source/api/mt_metadata/data/index
   /source/api/mt_metadata/features/index
   /source/api/mt_metadata/helper_functions/index
   /source/api/mt_metadata/processing/index
   /source/api/mt_metadata/timeseries/index
   /source/api/mt_metadata/transfer_functions/index
   /source/api/mt_metadata/utils/index


Attributes
----------

.. autoapisummary::

   mt_metadata.ACCEPTED_STYLES
   mt_metadata.REQUIRED_KEYS
   mt_metadata.DEFAULT_CHANNEL_NOMENCLATURE
   mt_metadata.NULL_VALUES
   mt_metadata.config
   mt_metadata.DATA_DIR
   mt_metadata.STATIONXML_01
   mt_metadata.STATIONXML_02
   mt_metadata.STATIONXML_MAGNETIC
   mt_metadata.STATIONXML_ELECTRIC
   mt_metadata.STATIONXML_FAP
   mt_metadata.STATIONXML_FIR
   mt_metadata.STATIONXML_MULTIPLE_NETWORKS
   mt_metadata.MT_EXPERIMENT_SINGLE_STATION
   mt_metadata.MT_EXPERIMENT_MULTIPLE_RUNS
   mt_metadata.MT_EXPERIMENT_MULTIPLE_RUNS_02
   mt_metadata.TF_ZMM
   mt_metadata.TF_ZSS_TIPPER
   mt_metadata.TF_JFILE
   mt_metadata.TF_XML
   mt_metadata.TF_XML_NO_SITE_LAYOUT
   mt_metadata.TF_XML_COMPLETE_REMOTE_INFO
   mt_metadata.TF_XML_WITH_DERIVED_QUANTITIES
   mt_metadata.TF_POOR_XML
   mt_metadata.TF_XML_MULTIPLE_ATTACHMENTS
   mt_metadata.TF_EDI_PHOENIX
   mt_metadata.TF_EDI_EMPOWER
   mt_metadata.TF_EDI_METRONIX
   mt_metadata.TF_EDI_CGG
   mt_metadata.TF_EDI_QUANTEC
   mt_metadata.TF_EDI_RHO_ONLY
   mt_metadata.TF_EDI_SPECTRA
   mt_metadata.TF_EDI_SPECTRA_OUT
   mt_metadata.TF_EDI_NO_ERROR
   mt_metadata.TF_AVG
   mt_metadata.TF_AVG_TIPPER
   mt_metadata.TF_AVG_NEWER


Package Contents
----------------

.. py:data:: ACCEPTED_STYLES
   :value: ['name', 'url', 'email', 'number', 'date', 'free form', 'time', 'date time', 'name list',...


.. py:data:: REQUIRED_KEYS
   :value: ['attribute', 'type', 'required', 'units', 'style', 'description', 'options', 'alias',...


.. py:data:: DEFAULT_CHANNEL_NOMENCLATURE

.. py:data:: NULL_VALUES
   :value: [None, '', 'null', 'None', 'NONE', 'NULL', 'Null', 'none', '1980-01-01T00:00:00',...


.. py:data:: config

.. py:data:: DATA_DIR

.. py:data:: STATIONXML_01

.. py:data:: STATIONXML_02

.. py:data:: STATIONXML_MAGNETIC

.. py:data:: STATIONXML_ELECTRIC

.. py:data:: STATIONXML_FAP

.. py:data:: STATIONXML_FIR

.. py:data:: STATIONXML_MULTIPLE_NETWORKS

.. py:data:: MT_EXPERIMENT_SINGLE_STATION

.. py:data:: MT_EXPERIMENT_MULTIPLE_RUNS

.. py:data:: MT_EXPERIMENT_MULTIPLE_RUNS_02

.. py:data:: TF_ZMM

.. py:data:: TF_ZSS_TIPPER

.. py:data:: TF_JFILE

.. py:data:: TF_XML

.. py:data:: TF_XML_NO_SITE_LAYOUT

.. py:data:: TF_XML_COMPLETE_REMOTE_INFO

.. py:data:: TF_XML_WITH_DERIVED_QUANTITIES

.. py:data:: TF_POOR_XML

.. py:data:: TF_XML_MULTIPLE_ATTACHMENTS

.. py:data:: TF_EDI_PHOENIX

.. py:data:: TF_EDI_EMPOWER

.. py:data:: TF_EDI_METRONIX

.. py:data:: TF_EDI_CGG

.. py:data:: TF_EDI_QUANTEC

.. py:data:: TF_EDI_RHO_ONLY

.. py:data:: TF_EDI_SPECTRA

.. py:data:: TF_EDI_SPECTRA_OUT

.. py:data:: TF_EDI_NO_ERROR

.. py:data:: TF_AVG

.. py:data:: TF_AVG_TIPPER

.. py:data:: TF_AVG_NEWER