mt_metadata.timeseries.stationxml

Tools to translate StationXML to MT Metadata

Submodules

• mt_metadata.timeseries.stationxml.fdsn_tools
• mt_metadata.timeseries.stationxml.utils
• mt_metadata.timeseries.stationxml.xml_channel_mt_channel
• mt_metadata.timeseries.stationxml.xml_equipment_mt_run
• mt_metadata.timeseries.stationxml.xml_inventory_mt_experiment
• mt_metadata.timeseries.stationxml.xml_network_mt_survey
• mt_metadata.timeseries.stationxml.xml_station_mt_station

Classes

XMLNetworkMTSurvey	translate back and forth between StationXML Network and MT Survey
XMLEquipmentMTRun	translate back and forth between StationXML Station and MT Station
XMLChannelMTChannel	translate back and forth between StationXML Channel and MT Channel
XMLInventoryMTExperiment	Read the full files and put the elements in the appropriate locations.

Package Contents

class mt_metadata.timeseries.stationxml.XMLNetworkMTSurvey

Bases: mt_metadata.timeseries.stationxml.utils.BaseTranslator

translate back and forth between StationXML Network and MT Survey

mt_translator

mt_comments_list = ['country', 'geographic_name', 'citation_journal.doi', 'id', 'project', 'acquired_by.author',...

xml_to_mt(network)

Translate a StationXML Network object to MT Survey object

Parameters:

network (obspy.core.inventory.Network) – StationXML network element

mt_to_xml(survey, code='ZU')

Convert MT Survey to Obspy Network

Note

For now the default code is ZU which is an IRIS catch-all network

class mt_metadata.timeseries.stationxml.XMLEquipmentMTRun

Bases: mt_metadata.timeseries.stationxml.utils.BaseTranslator

translate back and forth between StationXML Station and MT Station

xml_translator

mt_translator

mt_comments_list

mt_description_list = ['data_logger.firmware.author', 'data_logger.firmware.name', 'data_logger.firmware.version',...

xml_to_mt(equipment)

Read in an equipment block.

Parameters:

equipment (obspy.core.inventory.Equipment) – an Equipment element

mt_to_xml(mt_run)

Convert an :class:mt_metadata.timeseries.Run` to XML equipment and comments

Parameters:

mt_run (TYPE) – DESCRIPTION

Returns:

DESCRIPTION

Return type:

TYPE

class mt_metadata.timeseries.stationxml.XMLChannelMTChannel

Bases: mt_metadata.timeseries.stationxml.utils.BaseTranslator

translate back and forth between StationXML Channel and MT Channel

understood_sensor_types = ['logger', 'magnetometer', 'induction coil', 'coil', 'dipole', 'electrode']

mt_translator

mt_comments_list = ['run.id']

run_list = None

xml_to_mt(xml_channel, existing_filters={})

Translate obspy.core.inventory.Channel to mt_metadata.timeseries.Channel

Parameters:

xml_channel (obspy.core.inventory.Channel) – Obspy Channel object

Returns:

MT Channel

Return type:

mt_metadata.timeseries.Channel

mt_to_xml(mt_channel, filters_dict, hard_code=True)

Translate mt_metadata.timeseries.Channel to obspy.core.inventory.Channel

Parameters:

xml_channel (mt_metadata.timeseries.Channel) – MT Channel object

Returns:

MT Channel

Return type:

obspy.core.inventory.Channel

class mt_metadata.timeseries.stationxml.XMLInventoryMTExperiment

Read the full files and put the elements in the appropriate locations.

logger

network_translator

station_translator

channel_translator

xml_to_mt(inventory_object=None, stationxml_fn=None, mt_fn=None)

Read in a StationXML using Obspy obspy.core.inventory.Inventory and convert to an MT mt_metadata.timeseries.Experiment

Parameters:

• inventory_object (obspy.core.inventory.Inventory) – inventory object or StationXML file name

• stationxml_fn (Path or string) – full path to StationXML file

• mt_fn (Path or string) – full path to MT file

Returns:

DESCRIPTION

Return type:

TYPE

mt_to_xml(mt_experiment, mt_fn=None, stationxml_fn=None, ns_dict=None)

Convert from MT mt_metadata.timeseries.Experiment to obspy.core.inventory.Inventory

Parameters:

• mt_experiment (TYPE) – DESCRIPTION

• mt_fn (TYPE, optional) – DESCRIPTION, defaults to None

• stationxml_fn (TYPE, optional) – DESCRIPTION, defaults to None

• ns_dict (TYPE, optional) – DESCRIPTION, defaults to None

Raises:

ValueError – DESCRIPTION

Returns:

DESCRIPTION

Return type:

TYPE

add_run(xml_station, mt_run, filters_dict)

Check to see if channel information already exists in the channel list of an xml station.

Parameters:

• xml_station (TYPE) – DESCRIPTION

• xml_channel (TYPE) – DESCRIPTION

Returns:

DESCRIPTION

Return type:

TYPE

compare_xml_channel(xml_channel_01, xml_channel_02)

Compare xml channels to see if a new epoch needs to be made or not.

Parameters:

• xml_channel_01 (TYPE) – DESCRIPTION

• xml_channel_02 (TYPE) – DESCRIPTION

Returns:

DESCRIPTION

Return type:

TYPE