mt_metadata.transfer_functions.io.emtfxml
=========================================

.. py:module:: mt_metadata.transfer_functions.io.emtfxml


Submodules
----------

.. toctree::
   :maxdepth: 1

   /source/api/mt_metadata/transfer_functions/io/emtfxml/emtfxml/index
   /source/api/mt_metadata/transfer_functions/io/emtfxml/metadata/index


Classes
-------

.. autoapisummary::

   mt_metadata.transfer_functions.io.emtfxml.EMTFXML


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

.. py:class:: EMTFXML(fn=None, **kwargs)

   This is meant to follow Anna's XML schema for transfer functions

   [Kelbert2019](https://doi.org/10.1190/geo2018-0679.1).

   making this a MetadataBase object is complicated because of station
   and survey metadata, so we are going to leave this as just an object.


   .. py:attribute:: emtf


   .. py:attribute:: external_url


   .. py:attribute:: primary_data


   .. py:attribute:: attachment


   .. py:attribute:: provenance


   .. py:attribute:: copyright


   .. py:attribute:: site


   .. py:attribute:: field_notes


   .. py:attribute:: processing_info


   .. py:attribute:: statistical_estimates


   .. py:attribute:: data_types


   .. py:attribute:: site_layout


   .. py:attribute:: data


   .. py:attribute:: period_range


   .. py:property:: fn


   .. py:attribute:: element_keys
      :value: ['description', 'product_id', 'sub_type', 'notes', 'tags', 'external_url', 'primary_data',...



   .. py:property:: save_dir


   .. py:property:: description
      :type: str



   .. py:property:: product_id
      :type: str



   .. py:property:: tags
      :type: str



   .. py:property:: sub_type
      :type: str



   .. py:property:: notes
      :type: str



   .. py:method:: read(fn = None, get_elevation = False)

      Read xml file

      :param fn: XML file path to read, if None, use self.fn
      :type fn: str | Path
      :return: None
      :rtype: None




   .. py:method:: write(fn, skip_field_notes = False)

      Write an xml
      :param fn: XML file path to write
      :type fn: str | Path
      :return: None
      :rtype: None
      :rtype: TYPE




   .. py:property:: survey_metadata


   .. py:property:: station_metadata