mt_metadata.timeseries package

Subpackages

• mt_metadata.timeseries.filters package
  • Subpackages
    • mt_metadata.timeseries.filters.standards package
      • Module contents
  • Submodules
  • mt_metadata.timeseries.filters.channel_response_filter module
  • mt_metadata.timeseries.filters.coefficient_filter module
    • CoefficientFilter
      • CoefficientFilter.complex_response()
      • CoefficientFilter.to_obspy()
  • mt_metadata.timeseries.filters.filter_base module
    • FilterBase
      • FilterBase.calibration_date
      • FilterBase.complex_response()
      • FilterBase.decimation_active
      • FilterBase.from_obspy_stage()
      • FilterBase.generate_frequency_axis()
      • FilterBase.get_filter_description()
      • FilterBase.make_obspy_mapping()
      • FilterBase.name
      • FilterBase.obspy_mapping
      • FilterBase.pass_band()
      • FilterBase.plot_response()
      • FilterBase.total_gain
      • FilterBase.units_in
      • FilterBase.units_out
    • get_base_obspy_mapping()
  • mt_metadata.timeseries.filters.filtered module
    • Filtered
      • Filtered.applied
      • Filtered.name
  • mt_metadata.timeseries.filters.fir_filter module
    • FIRFilter
      • FIRFilter.coefficient_gain
      • FIRFilter.coefficients
      • FIRFilter.complex_response()
      • FIRFilter.corrective_scalar
      • FIRFilter.make_obspy_mapping()
      • FIRFilter.n_coefficients
      • FIRFilter.output_sampling_rate
      • FIRFilter.plot_fir_response()
      • FIRFilter.symmetry_corrected_coefficients
      • FIRFilter.to_obspy()
      • FIRFilter.unscaled_complex_response()
  • mt_metadata.timeseries.filters.frequency_response_table_filter module
    • FrequencyResponseTableFilter
      • FrequencyResponseTableFilter.amplitudes
      • FrequencyResponseTableFilter.complex_response()
      • FrequencyResponseTableFilter.frequencies
      • FrequencyResponseTableFilter.make_obspy_mapping()
      • FrequencyResponseTableFilter.max_frequency
      • FrequencyResponseTableFilter.min_frequency
      • FrequencyResponseTableFilter.phases
      • FrequencyResponseTableFilter.to_obspy()
  • mt_metadata.timeseries.filters.helper_functions module
    • decimation_info_is_degenerate()
    • decimation_info_is_pure_delay()
    • make_coefficient_filter()
    • make_frequency_response_table_filter()
    • make_tesla_to_nanotesla_converter()
    • make_volt_per_meter_to_millivolt_per_km_converter()
  • mt_metadata.timeseries.filters.obspy_stages module
    • check_if_coefficient_filter_is_delay_only()
    • create_coefficent_filter_from_stage()
    • create_filter_from_stage()
    • create_fir_filter_from_stage()
    • create_frequency_response_table_filter_from_stage()
    • create_pole_zero_filter_from_stage()
    • create_time_delay_filter_from_stage()
  • mt_metadata.timeseries.filters.plotting_helpers module
    • cast_angular_frequency_to_period_or_hertz()
    • is_flat_amplitude()
    • plot_response()
  • mt_metadata.timeseries.filters.pole_zero_filter module
    • PoleZeroFilter
      • PoleZeroFilter.complex_response()
      • PoleZeroFilter.make_obspy_mapping()
      • PoleZeroFilter.n_poles
      • PoleZeroFilter.n_zeros
      • PoleZeroFilter.normalization_frequency()
      • PoleZeroFilter.poles
      • PoleZeroFilter.to_obspy()
      • PoleZeroFilter.total_gain
      • PoleZeroFilter.zero_pole_gain_representation()
      • PoleZeroFilter.zeros
  • mt_metadata.timeseries.filters.time_delay_filter module
    • TimeDelayFilter
      • TimeDelayFilter.complex_response()
      • TimeDelayFilter.make_obspy_mapping()
      • TimeDelayFilter.to_obspy()
  • Module contents
    • ChannelResponse
      • ChannelResponse.complex_response()
      • ChannelResponse.compute_instrument_sensitivity()
      • ChannelResponse.delay_filters
      • ChannelResponse.filters_list
      • ChannelResponse.frequencies
      • ChannelResponse.get_indices_of_filters_to_remove()
      • ChannelResponse.get_list_of_filters_to_remove()
      • ChannelResponse.names
      • ChannelResponse.non_delay_filters
      • ChannelResponse.normalization_frequency
      • ChannelResponse.pass_band
      • ChannelResponse.plot_response()
      • ChannelResponse.to_obspy()
      • ChannelResponse.total_delay
      • ChannelResponse.units_in
      • ChannelResponse.units_out
    • CoefficientFilter
      • CoefficientFilter.complex_response()
      • CoefficientFilter.to_obspy()
    • FIRFilter
      • FIRFilter.coefficient_gain
      • FIRFilter.coefficients
      • FIRFilter.complex_response()
      • FIRFilter.corrective_scalar
      • FIRFilter.make_obspy_mapping()
      • FIRFilter.n_coefficients
      • FIRFilter.output_sampling_rate
      • FIRFilter.plot_fir_response()
      • FIRFilter.symmetry_corrected_coefficients
      • FIRFilter.to_obspy()
      • FIRFilter.unscaled_complex_response()
    • FrequencyResponseTableFilter
      • FrequencyResponseTableFilter.amplitudes
      • FrequencyResponseTableFilter.complex_response()
      • FrequencyResponseTableFilter.frequencies
      • FrequencyResponseTableFilter.make_obspy_mapping()
      • FrequencyResponseTableFilter.max_frequency
      • FrequencyResponseTableFilter.min_frequency
      • FrequencyResponseTableFilter.phases
      • FrequencyResponseTableFilter.to_obspy()
    • PoleZeroFilter
      • PoleZeroFilter.complex_response()
      • PoleZeroFilter.make_obspy_mapping()
      • PoleZeroFilter.n_poles
      • PoleZeroFilter.n_zeros
      • PoleZeroFilter.normalization_frequency()
      • PoleZeroFilter.poles
      • PoleZeroFilter.to_obspy()
      • PoleZeroFilter.total_gain
      • PoleZeroFilter.zero_pole_gain_representation()
      • PoleZeroFilter.zeros
    • TimeDelayFilter
      • TimeDelayFilter.complex_response()
      • TimeDelayFilter.make_obspy_mapping()
      • TimeDelayFilter.to_obspy()
• mt_metadata.timeseries.standards package
  • Module contents
• mt_metadata.timeseries.stationxml package
  • Submodules
  • mt_metadata.timeseries.stationxml.fdsn_tools module
    • angle()
    • create_location_code()
    • create_mt_component()
    • get_measurement_code()
    • get_orientation_code()
    • get_period_code()
    • make_channel_code()
    • read_channel_code()
  • mt_metadata.timeseries.stationxml.utils module
    • BaseTranslator
      • BaseTranslator.flip_dict()
      • BaseTranslator.get_comment()
      • BaseTranslator.make_mt_comments()
      • BaseTranslator.mt_to_xml()
      • BaseTranslator.read_xml_comment()
      • BaseTranslator.read_xml_identifier()
      • BaseTranslator.xml_to_mt()
  • mt_metadata.timeseries.stationxml.xml_channel_mt_channel module
    • XMLChannelMTChannel
      • XMLChannelMTChannel.mt_to_xml()
      • XMLChannelMTChannel.xml_to_mt()
  • mt_metadata.timeseries.stationxml.xml_equipment_mt_run module
    • XMLEquipmentMTRun
      • XMLEquipmentMTRun.mt_to_xml()
      • XMLEquipmentMTRun.xml_to_mt()
  • mt_metadata.timeseries.stationxml.xml_inventory_mt_experiment module
    • XMLInventoryMTExperiment
      • XMLInventoryMTExperiment.add_run()
      • XMLInventoryMTExperiment.compare_xml_channel()
      • XMLInventoryMTExperiment.mt_to_xml()
      • XMLInventoryMTExperiment.xml_to_mt()
  • mt_metadata.timeseries.stationxml.xml_network_mt_survey module
    • XMLNetworkMTSurvey
      • XMLNetworkMTSurvey.mt_to_xml()
      • XMLNetworkMTSurvey.xml_to_mt()
  • mt_metadata.timeseries.stationxml.xml_station_mt_station module
    • XMLStationMTStation
      • XMLStationMTStation.mt_to_xml()
      • XMLStationMTStation.xml_to_mt()
  • Module contents
    • XMLChannelMTChannel
      • XMLChannelMTChannel.mt_to_xml()
      • XMLChannelMTChannel.xml_to_mt()
    • XMLEquipmentMTRun
      • XMLEquipmentMTRun.mt_to_xml()
      • XMLEquipmentMTRun.xml_to_mt()
    • XMLInventoryMTExperiment
      • XMLInventoryMTExperiment.add_run()
      • XMLInventoryMTExperiment.compare_xml_channel()
      • XMLInventoryMTExperiment.mt_to_xml()
      • XMLInventoryMTExperiment.xml_to_mt()
    • XMLNetworkMTSurvey
      • XMLNetworkMTSurvey.mt_to_xml()
      • XMLNetworkMTSurvey.xml_to_mt()
    • XMLStationMTStation
      • XMLStationMTStation.mt_to_xml()
      • XMLStationMTStation.xml_to_mt()
• mt_metadata.timeseries.tools package
  • Submodules
  • mt_metadata.timeseries.tools.from_many_mt_files module
    • MT2StationXML
      • MT2StationXML.filters
      • MT2StationXML.get_mt_channel()
      • MT2StationXML.get_xml_files()
      • MT2StationXML.has_xml_path()
      • MT2StationXML.is_a_channel_xml()
      • MT2StationXML.is_a_filter_xml()
      • MT2StationXML.is_a_run_xml()
      • MT2StationXML.is_a_station_xml()
      • MT2StationXML.is_a_survey_xml()
      • MT2StationXML.make_df()
      • MT2StationXML.make_experiment()
      • MT2StationXML.read_xml_file()
      • MT2StationXML.sort_by_station()
      • MT2StationXML.stations
      • MT2StationXML.survey
      • MT2StationXML.xml_path
  • Module contents
    • MT2StationXML
      • MT2StationXML.filters
      • MT2StationXML.get_mt_channel()
      • MT2StationXML.get_xml_files()
      • MT2StationXML.has_xml_path()
      • MT2StationXML.is_a_channel_xml()
      • MT2StationXML.is_a_filter_xml()
      • MT2StationXML.is_a_run_xml()
      • MT2StationXML.is_a_station_xml()
      • MT2StationXML.is_a_survey_xml()
      • MT2StationXML.make_df()
      • MT2StationXML.make_experiment()
      • MT2StationXML.read_xml_file()
      • MT2StationXML.sort_by_station()
      • MT2StationXML.stations
      • MT2StationXML.survey
      • MT2StationXML.xml_path

Submodules

mt_metadata.timeseries.auxiliary module

Created on Wed Dec 23 21:30:36 2020

copyright:

Jared Peacock (jpeacock@usgs.gov)

license:

MIT

class mt_metadata.timeseries.auxiliary.Auxiliary(**kwargs)

Bases: Channel

Metadata Key	Description	Example
channel_number Required: True Units: None Type: integer Style: number Default: 0	Channel number on the data logger.	1
channel_id Required: False Units: None Type: string Style: free form Default: None	channel id given by the user or data logger	1001.11
comments Required: False Units: None Type: string Style: free form Default: None	Any comments about the channel.	ambient air temperature was chilly, ice on cables
component Required: True Units: None Type: string Style: controlled vocabulary Default: None	Name of the component measured, can be uppercase and/or lowercase. For now electric channels should start with an ‘e’ and magnetic channels start with an ‘h’, followed by the component. If there are multiples of the same channel the name could include an integer. {type}{component}{number} –> Ex01.	T
measurement_azimuth Required: True Units: degrees Type: float Style: number Default: 0.0	Horizontal azimuth of the channel in measurement coordinate system spcified in station.orientation.reference_frame. Default reference frame is a geographic right-handed coordinate system with north=0, east=90, vertical=+ downward.	0
measurement_tilt Required: True Units: degrees Type: float Style: number Default: 0.0	Vertical tilt of the channel in measurement coordinate system specified in station.orientation.reference_frame. Default reference frame is a geographic right-handed coordinate system with north=0, east=90, vertical=+ downward.	0
sample_rate Required: True Units: samples per second Type: float Style: number Default: 0.0	Digital sample rate	8
translated_azimuth Required: False Units: degrees Type: float Style: number Default: None	Horizontal azimuth of the channel in translated coordinate system, this should only be used for derived product. For instance if you collected your data in geomagnetic coordinates and then translated them to geographic coordinates you would set measurement_azimuth=0, translated_azimuth=-12.5 for a declination angle of N12.5E. angle of N12.5E.	0
translated_tilt Required: False Units: degrees Type: float Style: number Default: None	Tilt of channel in translated coordinate system, this should only be used for derived product. For instance if you collected your data using a tripod you would set measurement_tilt=45, translated_tilt=0 for a vertical component.	0
type Required: True Units: None Type: string Style: free form Default: None	Data type for the channel, should be a descriptive word that a user can understand.	temperature
units Required: True Units: None Type: string Style: controlled vocabulary Default: None	Units of the data, should be in SI units and represented as the full name of the unit all lowercase. If a complex unit use ‘per’ and ‘-‘.	celsius

mt_metadata.timeseries.battery module

Created on Wed Dec 23 21:30:36 2020

copyright:

Jared Peacock (jpeacock@usgs.gov)

license:

MIT

class mt_metadata.timeseries.battery.Battery(**kwargs)

Bases: Base

Metadata Key	Description	Example
type Required: False Units: None Type: string Style: name Default: None	Description of battery type.	pb-acid gel cell
id Required: False Units: None Type: string Style: name Default: None	battery id	battery01
voltage.start Required: False Units: None Type: float Style: number Default: None	Starting value of a diagnostic measurement.	12.3
voltage.end Required: False Units: None Type: float Style: number Default: None	Ending value of a diagnostic measurement.	10
comments Required: False Units: None Type: string Style: name Default: None	Any comments about the battery.	discharged too quickly

mt_metadata.timeseries.channel module

Created on Wed Dec 23 21:30:36 2020

copyright:

Jared Peacock (jpeacock@usgs.gov)

license:

MIT

class mt_metadata.timeseries.channel.Channel(**kwargs)

Bases: Base

Metadata Key	Description	Example
channel_number Required: True Units: None Type: integer Style: number Default: 0	Channel number on the data logger.	1
channel_id Required: False Units: None Type: string Style: free form Default: None	channel id given by the user or data logger	1001.11
comments Required: False Units: None Type: string Style: free form Default: None	Any comments about the channel.	ambient air temperature was chilly, ice on cables
component Required: True Units: None Type: string Style: controlled vocabulary Default: None	Name of the component measured, can be uppercase and/or lowercase. For now electric channels should start with an ‘e’ and magnetic channels start with an ‘h’, followed by the component. If there are multiples of the same channel the name could include an integer. {type}{component}{number} –> Ex01.	T
measurement_azimuth Required: True Units: degrees Type: float Style: number Default: 0.0	Horizontal azimuth of the channel in measurement coordinate system spcified in station.orientation.reference_frame. Default reference frame is a geographic right-handed coordinate system with north=0, east=90, vertical=+ downward.	0
measurement_tilt Required: True Units: degrees Type: float Style: number Default: 0.0	Vertical tilt of the channel in measurement coordinate system specified in station.orientation.reference_frame. Default reference frame is a geographic right-handed coordinate system with north=0, east=90, vertical=+ downward.	0
sample_rate Required: True Units: samples per second Type: float Style: number Default: 0.0	Digital sample rate	8
translated_azimuth Required: False Units: degrees Type: float Style: number Default: None	Horizontal azimuth of the channel in translated coordinate system, this should only be used for derived product. For instance if you collected your data in geomagnetic coordinates and then translated them to geographic coordinates you would set measurement_azimuth=0, translated_azimuth=-12.5 for a declination angle of N12.5E. angle of N12.5E.	0
translated_tilt Required: False Units: degrees Type: float Style: number Default: None	Tilt of channel in translated coordinate system, this should only be used for derived product. For instance if you collected your data using a tripod you would set measurement_tilt=45, translated_tilt=0 for a vertical component.	0
type Required: True Units: None Type: string Style: free form Default: None	Data type for the channel, should be a descriptive word that a user can understand.	temperature
units Required: True Units: None Type: string Style: controlled vocabulary Default: None	Units of the data, should be in SI units and represented as the full name of the unit all lowercase. If a complex unit use ‘per’ and ‘-‘.	celsius
data_quality.warnings Required: False Units: None Type: string Style: free form Default: None	any warnings about the data that should be noted	periodic pipeline noise
data_quality.good_from_period Required: False Units: None Type: float Style: number Default: None	Data are good for periods larger than this number	0.01
data_quality.good_to_period Required: False Units: None Type: float Style: number Default: None	Data are good for periods smaller than this number	1000
data_quality.flag Required: False Units: None Type: integer Style: number Default: None	Flag for data quality	0
data_quality.comments Required: False Units: None Type: string Style: free form Default: None	any comments about the data quality	0
data_quality.rating.author Required: False Units: None Type: string Style: free form Default: None	Author of who rated the data.	gradstudent ace
data_quality.rating.method Required: False Units: None Type: string Style: free form Default: None	The method used to rate the data.	standard deviation
data_quality.rating.value Required: True Units: None Type: integer Style: number Default: 0	A rating from 1-5 where 1 is bad and 5 is good and 0 if unrated.	4
filter.name Required: True Units: None Type: string Style: name list Default: []	Name of filter applied or to be applied. If more than one filter input as a comma separated list.	“[counts2mv, lo wpass_magnetic] “
filter.applied Required: True Units: None Type: boolean Style: name list Default: []	Boolean if filter has been applied or not. If more than one filter input as a comma separated list. Needs to be the same length as name or if only one entry is given it is assumed to apply to all filters listed.	“[True, False]”
filter.comments Required: False Units: None Type: string Style: name Default: None	Any comments on filters.	low pass is not calibrated
time_period.end Required: True Units: None Type: string Style: time Default: 1980-01-01T00:00:00+00:00	End date and time of collection in UTC.	2020-02-04T16:2 3:45.453670+00: 00
time_period.start Required: True Units: None Type: string Style: time Default: 1980-01-01T00:00:00+00:00	Start date and time of collection in UTC.	2020-02-01T09:2 3:45.453670+00: 00
sensor.id Required: True Units: None Type: string Style: free form Default: none	Instrument ID number can be serial number or a designated ID.	mt01
sensor.manufacturer Required: True Units: None Type: string Style: free form Default: none	Who manufactured the instrument.	mt gurus
sensor.type Required: True Units: None Type: string Style: free form Default: none	Description of the instrument type.	broadband 32-bit
sensor.model Required: False Units: None Type: string Style: free form Default: None	Model version of the instrument.	falcon5
sensor.name Required: False Units: None Type: string Style: free form Default: None	Standard marketing name of the instrument.	falcon5
fdsn.id Required: False Units: None Type: string Style: alpha numeric Default: None	Given FDSN archive ID name.	MT001
fdsn.network Required: False Units: None Type: string Style: alpha numeric Default: None	Given two character FDSN archive network code.	EM
fdsn.channel_code Required: False Units: None Type: string Style: alpha numeric Default: None	Three character FDSN channel code. http://docs.fdsn.org/projects/source- identifiers/en/v1.0/channel-codes.html	LQN
fdsn.new_epoch Required: False Units: None Type: boolean Style: name Default: None	Boolean telling if a new epoch needs to be created or not.	False
fdsn.alternate_code Required: False Units: None Type: string Style: free form Default: None	Alternate Code	_INT-NON_FDSN,. UNRESTRICTED,_U S-ALL,_US- MT,_US-MT-TA
fdsn.alternate_network_code Required: False Units: None Type: string Style: free form Default: None	Alternate Network Code	_INT-NON_FDSN,. UNRESTRICTED,_U S-ALL,_US- MT,_US-MT-TA
location.latitude Required: True Units: degrees Type: float Style: number Default: 0.0	latitude of location in datum specified at survey level	23.134
location.longitude Required: True Units: degrees Type: float Style: number Default: 0.0	longitude of location in datum specified at survey level	14.23
location.elevation Required: True Units: meters Type: float Style: number Default: 0.0	elevation of location in datum specified at survey level	123.4

channel_response(filters_dict)

full channel response from a dictionary of filter objects

property component

property unit_object

mt_metadata.timeseries.citation module

Created on Wed Dec 23 21:30:36 2020

copyright:

Jared Peacock (jpeacock@usgs.gov)

license:

MIT

class mt_metadata.timeseries.citation.Citation(**kwargs)

Bases: Base

Metadata Key	Description	Example
doi Required: True Units: None Type: string Style: url Default: None	full url of the doi number	http://doi.###
authors Required: False Units: None Type: string Style: free form Default: None	author names	M.Tee A. Roura
title Required: False Units: None Type: string Style: free form Default: None	Full title of the citation	Paper Title
year Required: False Units: None Type: string Style: date Default: 1980-01-01T00:00:00+00:00	Year of citation	2020
volume Required: False Units: None Type: string Style: free form Default: None	Journal volume of the citation	12
pages Required: False Units: None Type: string Style: free form Default: None	Page numbers of the citation	10-15
journal Required: False Units: None Type: string Style: free form Default: None	Journal title of citation	Journal of Geophysical Research

mt_metadata.timeseries.copyright module

Created on Wed Dec 23 21:30:36 2020

copyright:

Jared Peacock (jpeacock@usgs.gov)

license:

MIT

class mt_metadata.timeseries.copyright.Copyright(**kwargs)

Bases: Base

Metadata Key	Description	Example
release_license Required: True Units: None Type: string Style: controlled vocabulary Default: CC0-1.0	How the data can be used. The options are based on https://github.com/spdx/license- list-data	CC BY

mt_metadata.timeseries.data_logger module

Created on Wed Dec 23 21:30:36 2020

copyright:

Jared Peacock (jpeacock@usgs.gov)

license:

MIT

class mt_metadata.timeseries.data_logger.DataLogger(**kwargs)

Bases: Base

Metadata Key	Description	Example
id Required: True Units: None Type: string Style: free form Default: None	Instrument ID number can be serial number or a designated ID.	mt01
manufacturer Required: True Units: None Type: string Style: free form Default: None	Who manufactured the instrument.	mt gurus
type Required: True Units: None Type: string Style: free form Default: None	Description of the instrument type.	broadband 32-bit
model Required: False Units: None Type: string Style: free form Default: None	Model version of the instrument.	falcon5
name Required: False Units: None Type: string Style: free form Default: None	Standard marketing name of the instrument.	falcon5
timing_system.comments Required: False Units: None Type: string Style: free form Default: None	Any comment on the timing system.	GPS locked with internal quartz clock
timing_system.drift Required: True Units: seconds Type: float Style: number Default: 0.0	Estimated drift of the timing system.	0.001
timing_system.type Required: True Units: None Type: string Style: free form Default: GPS	Type of timing system.	GPS
timing_system.uncertainty Required: True Units: seconds Type: float Style: number Default: 0.0	Estimated uncertainty of the timing system.	0.0002
timing_system.n_satellites Required: False Units: None Type: integer Style: number Default: None	Number of satellites used for timing.	6
firmware.author Required: True Units: None Type: string Style: free form Default: none	Author of the software	Neo
firmware.version Required: True Units: None Type: string Style: free form Default: none	Software version	12.01a
firmware.last_updated Required: False Units: None Type: string Style: date Default: 1980-01-01T00:00:00+00:00	Most recent date the software was updated. Prefer to use version, but this works for non-versioned software.	2020-01-01
firmware.name Required: True Units: None Type: string Style: free form Default: none	Software name	mtrules
power_source.type Required: False Units: None Type: string Style: name Default: None	Description of battery type.	pb-acid gel cell
power_source.id Required: False Units: None Type: string Style: name Default: None	battery id	battery01
power_source.voltage.start Required: False Units: volts Type: float Style: number Default: None	Starting voltage	14.3
power_source.voltage.end Required: False Units: volts Type: float Style: number Default: None	Ending voltage	12.1
power_source.comments Required: False Units: None Type: string Style: name Default: None	Any comments about the battery.	discharged too quickly
data_storage.id Required: False Units: None Type: string Style: free form Default: none	Instrument ID number can be serial number or a designated ID.	mt01
data_storage.manufacturer Required: False Units: None Type: string Style: free form Default: none	Who manufactured the instrument.	mt gurus
data_storage.type Required: False Units: None Type: string Style: free form Default: none	Description of the instrument type.	broadband 32-bit
data_storage.model Required: False Units: None Type: string Style: free form Default: None	Model version of the instrument.	falcon5
data_storage.name Required: False Units: None Type: string Style: free form Default: None	Standard marketing name of the instrument.	falcon5

mt_metadata.timeseries.data_quality module

Created on Wed Dec 23 21:30:36 2020

copyright:

Jared Peacock (jpeacock@usgs.gov)

license:

MIT

class mt_metadata.timeseries.data_quality.DataQuality(**kwargs)

Bases: Base

Metadata Key	Description	Example
warnings Required: False Units: None Type: string Style: free form Default: None	any warnings about the data that should be noted	periodic pipeline noise
good_from_period Required: False Units: None Type: float Style: number Default: None	Data are good for periods larger than this number	0.01
good_to_period Required: False Units: None Type: float Style: number Default: None	Data are good for periods smaller than this number	1000
flag Required: False Units: None Type: integer Style: number Default: None	Flag for data quality	0
comments Required: False Units: None Type: string Style: free form Default: None	any comments about the data quality	0
rating.author Required: False Units: None Type: string Style: free form Default: None	Author of who rated the data.	gradstudent ace
rating.method Required: False Units: None Type: string Style: free form Default: None	The method used to rate the data.	standard deviation
rating.value Required: True Units: None Type: integer Style: number Default: 0	A rating from 1-5 where 1 is bad and 5 is good and 0 if unrated.	4

mt_metadata.timeseries.declination module

Created on Wed Dec 23 21:30:36 2020

copyright:

Jared Peacock (jpeacock@usgs.gov)

license:

MIT

class mt_metadata.timeseries.declination.Declination(**kwargs)

Bases: Base

Metadata Key	Description	Example
comments Required: False Units: None Type: string Style: free form Default: None	any comments on declination	estimated from WMM 2016
model Required: True Units: None Type: string Style: controlled vocabulary Default: WMM	geomagnetic reference model used to calculate declination	WMM
epoch Required: False Units: None Type: string Style: free form Default: None	Epoch for which declination was approximated in.	2020
value Required: True Units: degrees Type: float Style: number Default: 0.0	declination angle relative to geographic north positive clockwise	12.3

mt_metadata.timeseries.diagnostic module

Created on Wed Dec 23 21:30:36 2020

copyright:

Jared Peacock (jpeacock@usgs.gov)

license:

MIT

class mt_metadata.timeseries.diagnostic.Diagnostic(**kwargs)

Bases: Base

Metadata Key	Description	Example
end Required: False Units: None Type: float Style: number Default: None	Ending value of a diagnostic measurement.	10
start Required: False Units: None Type: float Style: number Default: None	Starting value of a diagnostic measurement.	12.3

mt_metadata.timeseries.electric module

Created on Wed Dec 23 21:30:36 2020

copyright:

Jared Peacock (jpeacock@usgs.gov)

license:

MIT

class mt_metadata.timeseries.electric.Electric(**kwargs)

Bases: Channel

Metadata Key	Description	Example
dipole_length Required: True Units: meters Type: float Style: number Default: 0.0	Length of the dipole as measured in a straight line from electrode to electrode.	55.25
contact_resistance.start Required: False Units: ohms Type: float Style: number list Default: None	Starting contact resistance; if more than one measurement input as a list of number [1 2 3 …].	“[1.2, 1.4]”
contact_resistance.end Required: False Units: ohms Type: float Style: number list Default: None	Ending contact resistance; if more than one measurement input as a list of number [1 2 3 …].	“[1.5, 1.8]”
ac.start Required: False Units: volts Type: float Style: number Default: None	Starting AC value; if more than one measurement input as a list of number [1 2 3 …].	“[52.1, 55.8]”
ac.end Required: False Units: volts Type: float Style: number Default: None	Ending AC value; if more than one measurement input as a list of number [1 2 3 …].	“[45.3, 49.5]”
dc.start Required: False Units: volts Type: float Style: number Default: None	Starting DC value; if more than one measurement input as a list of number [1 2 3 …].	1.1
dc.end Required: False Units: volts Type: float Style: number Default: None	Ending DC value; if more than one measurement input as a list of number [1 2 3 …].	1.5
channel_number Required: True Units: None Type: integer Style: number Default: 0	Channel number on the data logger.	1
channel_id Required: False Units: None Type: string Style: free form Default: None	channel id given by the user or data logger	1001.11
comments Required: False Units: None Type: string Style: free form Default: None	Any comments about the channel.	ambient air temperature was chilly, ice on cables
component Required: True Units: None Type: string Style: controlled vocabulary Default: None	Name of the component measured, can be uppercase and/or lowercase. For now electric channels should start with an ‘e’ and magnetic channels start with an ‘h’, followed by the component. If there are multiples of the same channel the name could include an integer. {type}{component}{number} –> Ex01.	T
measurement_azimuth Required: True Units: degrees Type: float Style: number Default: 0.0	Horizontal azimuth of the channel in measurement coordinate system spcified in station.orientation.reference_frame. Default reference frame is a geographic right-handed coordinate system with north=0, east=90, vertical=+ downward.	0
measurement_tilt Required: True Units: degrees Type: float Style: number Default: 0.0	Vertical tilt of the channel in measurement coordinate system specified in station.orientation.reference_frame. Default reference frame is a geographic right-handed coordinate system with north=0, east=90, vertical=+ downward.	0
sample_rate Required: True Units: samples per second Type: float Style: number Default: 0.0	Digital sample rate	8
translated_azimuth Required: False Units: degrees Type: float Style: number Default: None	Horizontal azimuth of the channel in translated coordinate system, this should only be used for derived product. For instance if you collected your data in geomagnetic coordinates and then translated them to geographic coordinates you would set measurement_azimuth=0, translated_azimuth=-12.5 for a declination angle of N12.5E. angle of N12.5E.	0
translated_tilt Required: False Units: degrees Type: float Style: number Default: None	Tilt of channel in translated coordinate system, this should only be used for derived product. For instance if you collected your data using a tripod you would set measurement_tilt=45, translated_tilt=0 for a vertical component.	0
type Required: True Units: None Type: string Style: free form Default: none	Data type for the channel, should be a descriptive word that a user can understand.	temperature
units Required: True Units: None Type: string Style: controlled vocabulary Default: None	Units of the data, should be in SI units and represented as the full name of the unit all lowercase. If a complex unit use ‘per’ and ‘-‘.	celsius
data_quality.warnings Required: False Units: None Type: string Style: free form Default: None	any warnings about the data that should be noted	periodic pipeline noise
data_quality.good_from_period Required: False Units: None Type: float Style: number Default: None	Data are good for periods larger than this number	0.01
data_quality.good_to_period Required: False Units: None Type: float Style: number Default: None	Data are good for periods smaller than this number	1000
data_quality.flag Required: False Units: None Type: integer Style: number Default: None	Flag for data quality	0
data_quality.comments Required: False Units: None Type: string Style: free form Default: None	any comments about the data quality	0
data_quality.rating.author Required: False Units: None Type: string Style: free form Default: None	Author of who rated the data.	gradstudent ace
data_quality.rating.method Required: False Units: None Type: string Style: free form Default: None	The method used to rate the data.	standard deviation
data_quality.rating.value Required: True Units: None Type: integer Style: number Default: 0	A rating from 1-5 where 1 is bad and 5 is good and 0 if unrated.	4
filter.name Required: True Units: None Type: string Style: name list Default: []	Name of filter applied or to be applied. If more than one filter input as a comma separated list.	“[counts2mv, lo wpass_magnetic] “
filter.applied Required: True Units: None Type: boolean Style: name list Default: []	Boolean if filter has been applied or not. If more than one filter input as a comma separated list. Needs to be the same length as name or if only one entry is given it is assumed to apply to all filters listed.	“[True, False]”
filter.comments Required: False Units: None Type: string Style: name Default: None	Any comments on filters.	low pass is not calibrated
positive.id Required: True Units: None Type: string Style: free form Default: None	Instrument ID number can be serial number or a designated ID.	mt01
positive.manufacturer Required: True Units: None Type: string Style: free form Default: None	Who manufactured the instrument.	mt gurus
positive.type Required: True Units: None Type: string Style: free form Default: None	Description of the instrument type.	broadband 32-bit
positive.model Required: False Units: None Type: string Style: free form Default: None	Model version of the instrument.	falcon5
positive.name Required: False Units: None Type: string Style: free form Default: None	Standard marketing name of the instrument.	falcon5
positive.latitude Required: True Units: degrees Type: float Style: number Default: 0.0	latitude of location in datum specified at survey level	23.134
positive.longitude Required: True Units: degrees Type: float Style: number Default: 0.0	longitude of location in datum specified at survey level	14.23
positive.elevation Required: True Units: meters Type: float Style: number Default: 0.0	elevation of location in datum specified at survey level	123.4
positive.latitude_uncertainty Required: False Units: degrees Type: float Style: number Default: None	uncertainty in latitude estimation in degrees	0.01
positive.longitude_uncertainty Required: False Units: degrees Type: float Style: number Default: None	uncertainty in longitude estimation in degrees	0.01
positive.elevation_uncertainty Required: False Units: meters Type: float Style: number Default: None	uncertainty in elevation estimation	0.01
positive.datum Required: False Units: None Type: string Style: controlled vocabulary Default: None	Datum of the location values. Usually a well known datum like WGS84.	WGS84
positive.x Required: False Units: meters Type: float Style: number Default: None	relative distance to the center of the station	10.0
positive.x2 Required: False Units: meters Type: float Style: number Default: None	relative distance to the center of the station	10.0
positive.y Required: False Units: meters Type: float Style: number Default: None	relative distance to the center of the station	10.0
positive.y2 Required: False Units: meters Type: float Style: number Default: None	relative distance to the center of the station	10.0
positive.z Required: False Units: meters Type: float Style: number Default: None	relative elevation to the center of the station	10.0
positive.z2 Required: False Units: meters Type: float Style: number Default: None	relative elevation to the center of the station	10.0
positive.x_uncertainty Required: False Units: meters Type: float Style: number Default: None	uncertainty in longitude estimation in x-direction	0.01
positive.y_uncertainty Required: False Units: meters Type: float Style: number Default: None	uncertainty in longitude estimation in y-direction	0.01
positive.z_uncertainty Required: False Units: meters Type: float Style: number Default: None	uncertainty in longitude estimation in z-direction	0.01
negative.id Required: True Units: None Type: string Style: free form Default: None	Instrument ID number can be serial number or a designated ID.	mt01
negative.manufacturer Required: True Units: None Type: string Style: free form Default: None	Who manufactured the instrument.	mt gurus
negative.type Required: True Units: None Type: string Style: free form Default: None	Description of the instrument type.	broadband 32-bit
negative.model Required: False Units: None Type: string Style: free form Default: None	Model version of the instrument.	falcon5
negative.name Required: False Units: None Type: string Style: free form Default: None	Standard marketing name of the instrument.	falcon5
negative.latitude Required: True Units: degrees Type: float Style: number Default: 0.0	latitude of location in datum specified at survey level	23.134
negative.longitude Required: True Units: degrees Type: float Style: number Default: 0.0	longitude of location in datum specified at survey level	14.23
negative.elevation Required: True Units: meters Type: float Style: number Default: 0.0	elevation of location in datum specified at survey level	123.4
negative.latitude_uncertainty Required: False Units: degrees Type: float Style: number Default: None	uncertainty in latitude estimation in degrees	0.01
negative.longitude_uncertainty Required: False Units: degrees Type: float Style: number Default: None	uncertainty in longitude estimation in degrees	0.01
negative.elevation_uncertainty Required: False Units: meters Type: float Style: number Default: None	uncertainty in elevation estimation	0.01
negative.datum Required: False Units: None Type: string Style: controlled vocabulary Default: None	Datum of the location values. Usually a well known datum like WGS84.	WGS84
negative.x Required: False Units: meters Type: float Style: number Default: None	relative distance to the center of the station	10.0
negative.x2 Required: False Units: meters Type: float Style: number Default: None	relative distance to the center of the station	10.0
negative.y Required: False Units: meters Type: float Style: number Default: None	relative distance to the center of the station	10.0
negative.y2 Required: False Units: meters Type: float Style: number Default: None	relative distance to the center of the station	10.0
negative.z Required: False Units: meters Type: float Style: number Default: None	relative elevation to the center of the station	10.0
negative.z2 Required: False Units: meters Type: float Style: number Default: None	relative elevation to the center of the station	10.0
negative.x_uncertainty Required: False Units: meters Type: float Style: number Default: None	uncertainty in longitude estimation in x-direction	0.01
negative.y_uncertainty Required: False Units: meters Type: float Style: number Default: None	uncertainty in longitude estimation in y-direction	0.01
negative.z_uncertainty Required: False Units: meters Type: float Style: number Default: None	uncertainty in longitude estimation in z-direction	0.01
time_period.end Required: True Units: None Type: string Style: time Default: 1980-01-01T00:00:00+00:00	End date and time of collection in UTC.	2020-02-04T16:2 3:45.453670+00: 00
time_period.start Required: True Units: None Type: string Style: time Default: 1980-01-01T00:00:00+00:00	Start date and time of collection in UTC.	2020-02-01T09:2 3:45.453670+00: 00

mt_metadata.timeseries.electrode module

Created on Wed Dec 23 21:30:36 2020

copyright:

Jared Peacock (jpeacock@usgs.gov)

license:

MIT

class mt_metadata.timeseries.electrode.Electrode(**kwargs)

Bases: Base

Metadata Key	Description	Example
id Required: True Units: None Type: string Style: free form Default: None	Instrument ID number can be serial number or a designated ID.	mt01
manufacturer Required: True Units: None Type: string Style: free form Default: None	Who manufactured the instrument.	mt gurus
type Required: True Units: None Type: string Style: free form Default: None	Description of the instrument type.	broadband 32-bit
model Required: False Units: None Type: string Style: free form Default: None	Model version of the instrument.	falcon5
name Required: False Units: None Type: string Style: free form Default: None	Standard marketing name of the instrument.	falcon5
latitude Required: True Units: degrees Type: float Style: number Default: 0.0	latitude of location in datum specified at survey level	23.134
longitude Required: True Units: degrees Type: float Style: number Default: 0.0	longitude of location in datum specified at survey level	14.23
elevation Required: True Units: meters Type: float Style: number Default: 0.0	elevation of location in datum specified at survey level	123.4
x Required: False Units: meters Type: float Style: number Default: None	relative distance to the center of the station	10.0
x2 Required: False Units: meters Type: float Style: number Default: None	relative distance to the center of the station	10.0
y Required: False Units: meters Type: float Style: number Default: None	relative distance to the center of the station	10.0
y2 Required: False Units: meters Type: float Style: number Default: None	relative distance to the center of the station	10.0
z Required: False Units: meters Type: float Style: number Default: None	relative elevation to the center of the station	10.0
z2 Required: False Units: meters Type: float Style: number Default: None	relative elevation to the center of the station	10.0

mt_metadata.timeseries.experiment module

Containers for the full metadata tree

Experiment –> Survey –> Station –> Run –> Channel

Each level has a list attribute

Created on Mon Feb 8 21:25:40 2021

copyright:

Jared Peacock (jpeacock@usgs.gov)

license:

MIT

class mt_metadata.timeseries.experiment.Experiment(surveys=[])

Bases: Base

Top level of the metadata

add_survey(survey_obj)

Add a survey, if has the same name update that object.

Parameters:

survey_obj (:class:`mt_metadata.timeseries.Survey) – DESCRIPTION

Returns:

DESCRIPTION

Return type:

TYPE

from_dict(ex_dict, skip_none=True)

fill from an input dictionary

Parameters:

ex_dict (TYPE) – DESCRIPTION

Returns:

DESCRIPTION

Return type:

TYPE

from_json(json_str, skip_none=True)

read in a json string and update attributes of an object

Parameters:

json_str (string or pathlib.Path) – json string or file path

from_pickle(fn)

Read pickle version of experiment

Parameters:

fn (TYPE) – DESCRIPTION

Returns:

DESCRIPTION

Return type:

TYPE

from_xml(fn=None, element=None, sort=True, skip_none=True)

Parameters:

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

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

Returns:

DESCRIPTION

Return type:

TYPE

get_survey(survey_id)

Get a survey from the survey id

Parameters:

survey_id (TYPE) – DESCRIPTION

Returns:

DESCRIPTION

Return type:

TYPE

has_survey(survey_id)

Has survey id

Parameters:

survey_id (TYPE) – DESCRIPTION

Returns:

DESCRIPTION

Return type:

TYPE

sort(inplace=True)

sort surveys, stations, runs, channels alphabetically/numerically

Parameters:

inplace (TYPE, optional) – DESCRIPTION, defaults to True

Returns:

DESCRIPTION

Return type:

TYPE

survey_index(survey_id)

Get survey index

Parameters:

survey_id (TYPE) – DESCRIPTION

Returns:

DESCRIPTION

Return type:

TYPE

property survey_names

Return names of surveys in experiment

property surveys

Return survey list

to_dict(nested=False, required=True)

create a dictionary for the experiment object.

Parameters:

• nested (TYPE, optional) – DESCRIPTION, defaults to False

• single (TYPE, optional) – DESCRIPTION, defaults to False

• required (TYPE, optional) – DESCRIPTION, defaults to True

Returns:

DESCRIPTION

Return type:

TYPE

to_json(fn=None, nested=False, indent='    ', required=True)

Write a json string from a given object, taking into account other class objects contained within the given object.

Parameters:

nested ([ True | False ] , default is False) – make the returned json nested

to_pickle(fn)

Write a pickle version of the experiment

Parameters:

fn (TYPE) – DESCRIPTION

Returns:

DESCRIPTION

Return type:

TYPE

to_xml(fn=None, required=True, sort=True)

Write XML version of the experiment

Parameters:

fn (TYPE) – DESCRIPTION

Returns:

DESCRIPTION

Return type:

TYPE

validate_experiment()

Validate experiment is legal

Returns:

DESCRIPTION

Return type:

TYPE

mt_metadata.timeseries.fdsn module

Created on Wed Dec 23 21:30:36 2020

copyright:

Jared Peacock (jpeacock@usgs.gov)

license:

MIT

class mt_metadata.timeseries.fdsn.Fdsn(**kwargs)

Bases: Base

Metadata Key	Description	Example
id Required: False Units: None Type: string Style: alpha numeric Default: None	Given FDSN archive ID name.	MT001
network Required: False Units: None Type: string Style: alpha numeric Default: None	Given two character FDSN archive network code.	EM
channel_code Required: False Units: None Type: string Style: alpha numeric Default: None	Three character FDSN channel code. http://docs.fdsn.org/projects/source- identifiers/en/v1.0/channel-codes.html	LQN
new_epoch Required: False Units: None Type: boolean Style: name Default: None	Boolean telling if a new epoch needs to be created or not.	False
alternate_code Required: False Units: None Type: string Style: free form Default: None	Alternate Code	_INT-NON_FDSN,. UNRESTRICTED,_U S-ALL,_US- MT,_US-MT-TA
alternate_network_code Required: False Units: None Type: string Style: free form Default: None	Alternate Network Code	_INT-NON_FDSN,. UNRESTRICTED,_U S-ALL,_US- MT,_US-MT-TA

mt_metadata.timeseries.instrument module

Created on Wed Dec 23 21:30:36 2020

copyright:

Jared Peacock (jpeacock@usgs.gov)

license:

MIT

class mt_metadata.timeseries.instrument.Instrument(**kwargs)

Bases: Base

Metadata Key	Description	Example
id Required: True Units: None Type: string Style: free form Default: None	Instrument ID number can be serial number or a designated ID.	mt01
manufacturer Required: True Units: None Type: string Style: free form Default: None	Who manufactured the instrument.	mt gurus
type Required: True Units: None Type: string Style: free form Default: None	Description of the instrument type.	broadband 32-bit
model Required: False Units: None Type: string Style: free form Default: None	Model version of the instrument.	falcon5
name Required: False Units: None Type: string Style: free form Default: None	Standard marketing name of the instrument.	falcon5

mt_metadata.timeseries.location module

Created on Wed Dec 23 21:30:36 2020

copyright:

Jared Peacock (jpeacock@usgs.gov)

license:

MIT

class mt_metadata.timeseries.location.Location(**kwargs)

Bases: Base

Metadata Key	Description	Example
latitude Required: True Units: degrees Type: float Style: number Default: 0.0	latitude of location in datum specified at survey level	23.134
longitude Required: True Units: degrees Type: float Style: number Default: 0.0	longitude of location in datum specified at survey level	14.23
elevation Required: True Units: meters Type: float Style: number Default: 0.0	elevation of location in datum specified at survey level	123.4
latitude_uncertainty Required: False Units: degrees Type: float Style: number Default: None	uncertainty in latitude estimation in degrees	0.01
longitude_uncertainty Required: False Units: degrees Type: float Style: number Default: None	uncertainty in longitude estimation in degrees	0.01
elevation_uncertainty Required: False Units: meters Type: float Style: number Default: None	uncertainty in elevation estimation	0.01
datum Required: False Units: None Type: string Style: controlled vocabulary Default: None	Datum of the location values. Usually a well known datum like WGS84.	WGS84
x Required: False Units: meters Type: float Style: number Default: None	relative distance to the center of the station	10.0
x2 Required: False Units: meters Type: float Style: number Default: None	relative distance to the center of the station	10.0
y Required: False Units: meters Type: float Style: number Default: None	relative distance to the center of the station	10.0
y2 Required: False Units: meters Type: float Style: number Default: None	relative distance to the center of the station	10.0
z Required: False Units: meters Type: float Style: number Default: None	relative elevation to the center of the station	10.0
z2 Required: False Units: meters Type: float Style: number Default: None	relative elevation to the center of the station	10.0
x_uncertainty Required: False Units: meters Type: float Style: number Default: None	uncertainty in longitude estimation in x-direction	0.01
y_uncertainty Required: False Units: meters Type: float Style: number Default: None	uncertainty in longitude estimation in y-direction	0.01
z_uncertainty Required: False Units: meters Type: float Style: number Default: None	uncertainty in longitude estimation in z-direction	0.01
declination.comments Required: False Units: None Type: string Style: free form Default: None	any comments on declination	estimated from WMM 2016
declination.model Required: True Units: None Type: string Style: controlled vocabulary Default: WMM	geomagnetic reference model used to calculate declination	WMM
declination.epoch Required: False Units: None Type: string Style: free form Default: None	Epoch for which declination was approximated in.	2020
declination.value Required: True Units: degrees Type: float Style: number Default: 0.0	declination angle relative to geographic north positive clockwise	12.3

property elevation

property latitude

property longitude

mt_metadata.timeseries.magnetic module

Created on Wed Dec 23 21:30:36 2020

copyright:

Jared Peacock (jpeacock@usgs.gov)

license:

MIT

class mt_metadata.timeseries.magnetic.Magnetic(**kwargs)

Bases: Channel

Metadata Key	Description	Example
h_field_min.start Required: False Units: nt Type: float Style: number Default: None	Minimum magnetic field strength at beginning of measurement.	40345.1
h_field_min.end Required: False Units: nt Type: float Style: number Default: None	Minimum magnetic field strength at end of measurement.	50453.2
h_field_max.start Required: False Units: nt Type: float Style: number Default: None	Maximum magnetic field strength at beginning of measurement.	34565.2
h_field_max.end Required: False Units: nt Type: float Style: number Default: None	Maximum magnetic field strength at end of measurement.	34526.1
channel_number Required: True Units: None Type: integer Style: number Default: 0	Channel number on the data logger.	1
channel_id Required: False Units: None Type: string Style: free form Default: None	channel id given by the user or data logger	1001.11
comments Required: False Units: None Type: string Style: free form Default: None	Any comments about the channel.	ambient air temperature was chilly, ice on cables
component Required: True Units: None Type: string Style: controlled vocabulary Default: None	Name of the component measured, can be uppercase and/or lowercase. For now electric channels should start with an ‘e’ and magnetic channels start with an ‘h’, followed by the component. If there are multiples of the same channel the name could include an integer. {type}{component}{number} –> Ex01.	T
measurement_azimuth Required: True Units: degrees Type: float Style: number Default: 0.0	Horizontal azimuth of the channel in measurement coordinate system spcified in station.orientation.reference_frame. Default reference frame is a geographic right-handed coordinate system with north=0, east=90, vertical=+ downward.	0
measurement_tilt Required: True Units: degrees Type: float Style: number Default: 0.0	Vertical tilt of the channel in measurement coordinate system specified in station.orientation.reference_frame. Default reference frame is a geographic right-handed coordinate system with north=0, east=90, vertical=+ downward.	0
sample_rate Required: True Units: samples per second Type: float Style: number Default: 0.0	Digital sample rate	8
translated_azimuth Required: False Units: degrees Type: float Style: number Default: None	Horizontal azimuth of the channel in translated coordinate system, this should only be used for derived product. For instance if you collected your data in geomagnetic coordinates and then translated them to geographic coordinates you would set measurement_azimuth=0, translated_azimuth=-12.5 for a declination angle of N12.5E. angle of N12.5E.	0
translated_tilt Required: False Units: degrees Type: float Style: number Default: None	Tilt of channel in translated coordinate system, this should only be used for derived product. For instance if you collected your data using a tripod you would set measurement_tilt=45, translated_tilt=0 for a vertical component.	0
type Required: True Units: None Type: string Style: free form Default: none	Data type for the channel, should be a descriptive word that a user can understand.	temperature
units Required: True Units: None Type: string Style: controlled vocabulary Default: None	Units of the data, should be in SI units and represented as the full name of the unit all lowercase. If a complex unit use ‘per’ and ‘-‘.	celsius
data_quality.warnings Required: False Units: None Type: string Style: free form Default: None	any warnings about the data that should be noted	periodic pipeline noise
data_quality.good_from_period Required: False Units: None Type: float Style: number Default: None	Data are good for periods larger than this number	0.01
data_quality.good_to_period Required: False Units: None Type: float Style: number Default: None	Data are good for periods smaller than this number	1000
data_quality.flag Required: False Units: None Type: integer Style: number Default: None	Flag for data quality	0
data_quality.comments Required: False Units: None Type: string Style: free form Default: None	any comments about the data quality	0
data_quality.rating.author Required: False Units: None Type: string Style: free form Default: None	Author of who rated the data.	gradstudent ace
data_quality.rating.method Required: False Units: None Type: string Style: free form Default: None	The method used to rate the data.	standard deviation
data_quality.rating.value Required: True Units: None Type: integer Style: number Default: 0	A rating from 1-5 where 1 is bad and 5 is good and 0 if unrated.	4
filter.name Required: True Units: None Type: string Style: name list Default: []	Name of filter applied or to be applied. If more than one filter input as a comma separated list.	“[counts2mv, lo wpass_magnetic] “
filter.applied Required: True Units: None Type: boolean Style: name list Default: []	Boolean if filter has been applied or not. If more than one filter input as a comma separated list. Needs to be the same length as name or if only one entry is given it is assumed to apply to all filters listed.	“[True, False]”
filter.comments Required: False Units: None Type: string Style: name Default: None	Any comments on filters.	low pass is not calibrated
time_period.end Required: True Units: None Type: string Style: time Default: 1980-01-01T00:00:00+00:00	End date and time of collection in UTC.	2020-02-04T16:2 3:45.453670+00: 00
time_period.start Required: True Units: None Type: string Style: time Default: 1980-01-01T00:00:00+00:00	Start date and time of collection in UTC.	2020-02-01T09:2 3:45.453670+00: 00
sensor.id Required: True Units: None Type: string Style: free form Default: none	Instrument ID number can be serial number or a designated ID.	mt01
sensor.manufacturer Required: True Units: None Type: string Style: free form Default: none	Who manufactured the instrument.	mt gurus
sensor.type Required: True Units: None Type: string Style: free form Default: none	Description of the instrument type.	broadband 32-bit
sensor.model Required: False Units: None Type: string Style: free form Default: None	Model version of the instrument.	falcon5
sensor.name Required: False Units: None Type: string Style: free form Default: None	Standard marketing name of the instrument.	falcon5
fdsn.id Required: False Units: None Type: string Style: alpha numeric Default: None	Given FDSN archive ID name.	MT001
fdsn.network Required: False Units: None Type: string Style: alpha numeric Default: None	Given two character FDSN archive network code.	EM
fdsn.channel_code Required: False Units: None Type: string Style: alpha numeric Default: None	Three character FDSN channel code. http://docs.fdsn.org/projects/source- identifiers/en/v1.0/channel-codes.html	LQN
fdsn.new_epoch Required: False Units: None Type: boolean Style: name Default: None	Boolean telling if a new epoch needs to be created or not.	False
fdsn.alternate_code Required: False Units: None Type: string Style: free form Default: None	Alternate Code	_INT-NON_FDSN,. UNRESTRICTED,_U S-ALL,_US- MT,_US-MT-TA
fdsn.alternate_network_code Required: False Units: None Type: string Style: free form Default: None	Alternate Network Code	_INT-NON_FDSN,. UNRESTRICTED,_U S-ALL,_US- MT,_US-MT-TA
location.latitude Required: True Units: degrees Type: float Style: number Default: 0.0	latitude of location in datum specified at survey level	23.134
location.longitude Required: True Units: degrees Type: float Style: number Default: 0.0	longitude of location in datum specified at survey level	14.23
location.elevation Required: True Units: meters Type: float Style: number Default: 0.0	elevation of location in datum specified at survey level	123.4
location.x Required: False Units: meters Type: float Style: number Default: None	relative distance to the center of the station	10.0
location.y Required: False Units: meters Type: float Style: number Default: None	relative distance to the center of the station	10.0
location.z Required: False Units: meters Type: float Style: number Default: None	relative elevation to the center of the station	10.0

mt_metadata.timeseries.orientation module

Created on Wed Dec 23 21:30:36 2020

copyright:

Jared Peacock (jpeacock@usgs.gov)

license:

MIT

class mt_metadata.timeseries.orientation.Orientation(**kwargs)

Bases: Base

Metadata Key	Description	Example
method Required: True Units: None Type: string Style: controlled vocabulary Default: None	method for orienting station layout	compass
reference_frame Required: True Units: None Type: string Style: controlled vocabulary Default: geographic	“Reference frame for station layout. There are only 2 options geographic and geomagnetic. Both assume a right-handed coordinate system with North=0 E=90 and vertical positive downward”	geomagnetic
angle_to_geographic_north Required: False Units: degrees Type: float Style: number Default: None	“Angle to rotate the data to align with geographic north. If this number is 0 then it is assumed the data are aligned with geographic north in a right handed coordinate system.”	geomagnetic
value Required: False Units: None Type: string Style: controlled vocabulary Default: None	“Channel orientation relative to each other”	orthogonal

mt_metadata.timeseries.person module

Created on Wed Dec 23 21:30:36 2020

copyright:

Jared Peacock (jpeacock@usgs.gov)

license:

MIT

class mt_metadata.timeseries.person.Person(**kwargs)

Bases: Base

Metadata Key	Description	Example
name Required: True Units: None Type: string Style: free form Default: None	Persons name, should be full first and last name.	person name
author Required: False Units: None Type: string Style: free form Default: None	Persons name, should be full first and last name.	person name
organization Required: False Units: None Type: string Style: free form Default: None	Organization full name	mt gurus
email Required: False Units: None Type: string Style: email Default: None	Email of the contact person	mt.guru@em.org
url Required: False Units: None Type: string Style: free form Default: None	URL of the contact person	em.org
comments Required: False Units: None Type: string Style: email Default: None	Any comments about the person	expert digger

property author

mt_metadata.timeseries.provenance module

Created on Wed Dec 23 21:30:36 2020

copyright:

Jared Peacock (jpeacock@usgs.gov)

license:

MIT

class mt_metadata.timeseries.provenance.Provenance(**kwargs)

Bases: Base

Metadata Key	Description	Example
creation_time Required: True Units: None Type: string Style: date time Default: 1980-01-01T00:00:00+00:00	Date and time the file was created.	2020-02-08T12:2 3:40.324600+00: 00
comments Required: False Units: None Type: string Style: free form Default: None	Any comments on provenance of the data.	all good
log Required: False Units: None Type: string Style: free form Default: None	A history of changes made to the data.	2020-02-10T14:2 4:45+00:00 updated metadata
creator.name Required: True Units: None Type: string Style: free form Default: none	Persons name, should be full first and last name.	person name
creator.author Required: False Units: None Type: string Style: free form Default: None	Persons name, should be full first and last name.	person name
creator.organization Required: False Units: None Type: string Style: free form Default: None	Organization full name	mt gurus
creator.email Required: False Units: None Type: string Style: email Default: None	Email of the contact person	mt.guru@em.org
creator.url Required: False Units: None Type: string Style: free form Default: None	URL of the contact person	em.org
creator.comments Required: False Units: None Type: string Style: email Default: None	Any comments about the person	expert digger
submitter.name Required: True Units: None Type: string Style: free form Default: none	Persons name, should be full first and last name.	person name
submitter.author Required: False Units: None Type: string Style: free form Default: None	Persons name, should be full first and last name.	person name
submitter.organization Required: False Units: None Type: string Style: free form Default: None	Organization full name	mt gurus
submitter.email Required: False Units: None Type: string Style: email Default: None	Email of the contact person	mt.guru@em.org
submitter.url Required: False Units: None Type: string Style: free form Default: None	URL of the contact person	em.org
submitter.comments Required: False Units: None Type: string Style: email Default: None	Any comments about the person	expert digger
archive.name Required: True Units: None Type: string Style: free form Default: none	Persons name, should be full first and last name.	person name
archive.author Required: False Units: None Type: string Style: free form Default: None	Persons name, should be full first and last name.	person name
archive.organization Required: False Units: None Type: string Style: free form Default: None	Organization full name	mt gurus
archive.email Required: False Units: None Type: string Style: email Default: None	Email of the contact person	mt.guru@em.org
archive.url Required: False Units: None Type: string Style: free form Default: None	URL of the contact person	em.org
archive.comments Required: False Units: None Type: string Style: email Default: None	Any comments about the person	expert digger
software.author Required: True Units: None Type: string Style: free form Default: none	Author of the software	Neo
software.version Required: True Units: None Type: string Style: free form Default: none	Software version	12.01a
software.last_updated Required: False Units: None Type: string Style: date Default: 1980-01-01T00:00:00+00:00	Most recent date the software was updated. Prefer to use version, but this works for non-versioned software.	2020-01-01
software.name Required: True Units: None Type: string Style: free form Default: none	Software name	mtrules

property creation_time

mt_metadata.timeseries.rating module

Created on Wed Dec 23 21:30:36 2020

copyright:

Jared Peacock (jpeacock@usgs.gov)

license:

MIT

class mt_metadata.timeseries.rating.Rating(**kwargs)

Bases: Base

Metadata Key	Description	Example
author Required: False Units: None Type: string Style: free form Default: None	Author of who rated the data.	gradstudent ace
method Required: False Units: None Type: string Style: free form Default: None	The method used to rate the data.	standard deviation
value Required: True Units: None Type: integer Style: number Default: 0	A rating from 1-5 where 1 is bad and 5 is good and 0 if unrated.	4

mt_metadata.timeseries.run module

Created on Wed Dec 23 21:30:36 2020

copyright:

Jared Peacock (jpeacock@usgs.gov)

license:

MIT

class mt_metadata.timeseries.run.Run(**kwargs)

Bases: Base

Metadata Key	Description	Example
channels_recorded_auxiliary Required: True Units: None Type: string Style: name list Default: []	List of auxiliary channels recorded	[T]
channels_recorded_electric Required: True Units: None Type: string Style: name list Default: []	List of electric channels recorded	“[Ex , Ey]”
channels_recorded_magnetic Required: True Units: None Type: string Style: name list Default: []	List of magnetic channels recorded	“[Hx , Hy , Hz]”
comments Required: False Units: None Type: string Style: free form Default: None	Any comments on the run.	cows chewed cables
data_type Required: True Units: None Type: string Style: controlled vocabulary Default: BBMT	Type of data recorded for this run.	BBMT
id Required: True Units: None Type: string Style: alpha numeric Default: None	Run ID should be station name followed by a number or character. Characters should only be used if the run number is small, if the run number is high consider using digits with zeros. For example if you have 100 runs the run ID could be 001 or {station}001.	001
sample_rate Required: True Units: samples per second Type: float Style: number Default: 0.0	Digital sample rate for the run	100
fdsn.id Required: False Units: None Type: string Style: alpha numeric Default: None	Given FDSN archive ID name.	MT001
fdsn.network Required: False Units: None Type: string Style: alpha numeric Default: None	Given two character FDSN archive network code.	EM
fdsn.channel_code Required: False Units: None Type: string Style: alpha numeric Default: None	Three character FDSN channel code. http://docs.fdsn.org/projects/source- identifiers/en/v1.0/channel-codes.html	LQN
fdsn.new_epoch Required: False Units: None Type: boolean Style: name Default: None	Boolean telling if a new epoch needs to be created or not.	False
fdsn.alternate_code Required: False Units: None Type: string Style: free form Default: None	Alternate Code	_INT-NON_FDSN,. UNRESTRICTED,_U S-ALL,_US- MT,_US-MT-TA
fdsn.alternate_network_code Required: False Units: None Type: string Style: free form Default: None	Alternate Network Code	_INT-NON_FDSN,. UNRESTRICTED,_U S-ALL,_US- MT,_US-MT-TA
data_logger.id Required: True Units: None Type: string Style: free form Default: none	Instrument ID number can be serial number or a designated ID.	mt01
data_logger.manufacturer Required: True Units: None Type: string Style: free form Default: none	Who manufactured the instrument.	mt gurus
data_logger.type Required: True Units: None Type: string Style: free form Default: none	Description of the instrument type.	broadband 32-bit
data_logger.model Required: False Units: None Type: string Style: free form Default: None	Model version of the instrument.	falcon5
data_logger.name Required: False Units: None Type: string Style: free form Default: None	Standard marketing name of the instrument.	falcon5
data_logger.timing_system.comments Required: False Units: None Type: string Style: free form Default: None	Any comment on the timing system.	GPS locked with internal quartz clock
data_logger.timing_system.drift Required: True Units: seconds Type: float Style: number Default: 0.0	Estimated drift of the timing system.	0.001
data_logger.timing_system.type Required: True Units: None Type: string Style: free form Default: GPS	Type of timing system.	GPS
data_logger.timing_system.uncertainty Required: True Units: seconds Type: float Style: number Default: 0.0	Estimated uncertainty of the timing system.	0.0002
data_logger.timing_system.n_satellites Required: False Units: None Type: integer Style: number Default: None	Number of satellites used for timing.	6
data_logger.firmware.author Required: True Units: None Type: string Style: free form Default: None	Author of the software	Neo
data_logger.firmware.version Required: True Units: None Type: string Style: free form Default: None	Software version	12.01a
data_logger.firmware.last_updated Required: False Units: None Type: string Style: date Default: 1980-01-01T00:00:00+00:00	Most recent date the software was updated. Prefer to use version, but this works for non-versioned software.	2020-01-01
data_logger.firmware.name Required: True Units: None Type: string Style: free form Default: None	Software name	mtrules
data_logger.power_source.type Required: False Units: None Type: string Style: name Default: None	Description of battery type.	pb-acid gel cell
data_logger.power_source.id Required: False Units: None Type: string Style: name Default: None	battery id	battery01
data_logger.power_source.voltage.start Required: False Units: volts Type: float Style: number Default: None	Starting voltage	14.3
data_logger.power_source.voltage.end Required: False Units: volts Type: float Style: number Default: None	Ending voltage	12.1
data_logger.power_source.comments Required: False Units: None Type: string Style: name Default: None	Any comments about the battery.	discharged too quickly
time_period.end Required: True Units: None Type: string Style: time Default: 1980-01-01T00:00:00+00:00	End date and time of collection in UTC.	2020-02-04T16:2 3:45.453670+00: 00
time_period.start Required: True Units: None Type: string Style: time Default: 1980-01-01T00:00:00+00:00	Start date and time of collection in UTC.	2020-02-01T09:2 3:45.453670+00: 00
acquired_by.author Required: False Units: None Type: string Style: free form Default: None	Persons name, should be full first and last name.	person name
acquired_by.organization Required: False Units: None Type: string Style: free form Default: None	Organization full name	mt gurus
acquired_by.comments Required: False Units: None Type: string Style: email Default: None	Any comments about the person	expert digger
metadata_by.author Required: False Units: None Type: string Style: free form Default: None	Persons name, should be full first and last name.	person name
metadata_by.organization Required: False Units: None Type: string Style: free form Default: None	Organization full name	mt gurus
metadata_by.comments Required: False Units: None Type: string Style: email Default: None	Any comments about the person	expert digger
provenance.comments Required: False Units: None Type: string Style: free form Default: None	Any comments on provenance of the data.	all good
provenance.log Required: False Units: None Type: string Style: free form Default: None	A history of changes made to the data.	2020-02-10T14:2 4:45+00:00 updated metadata

add_channel(channel_obj, update=True)

Add a channel to the list, check if one exists if it does overwrite it

Parameters:

channel_obj (mt_metadata.timeseries.Channel) – channel object to add

channel_index(component)

get index of the channel in the channel list

property channels

List of channels in the run

property channels_recorded_all

a list of all channels recorded :rtype: TYPE

Type:

return

property channels_recorded_auxiliary

property channels_recorded_electric

property channels_recorded_magnetic

property ex

property ey

get_channel(component)

Get a channel

Parameters:

component (string) – channel component to look for

Returns:

channel object based on channel type

Return type:

mt_metadata.timeseries.Channel

has_channel(component)

Check to see if the channel already exists

Parameters:

component (string) – channel component to look for

Returns:

True if found, False if not

Return type:

boolean

property hx

property hy

property hz

property n_channels

remove_channel(channel_id)

remove a run from the survey

Parameters:

component (string) – channel component to look for

property temperature

update(other, match=[])

Update attribute values from another like element, skipping None

Parameters:

other (TYPE) – DESCRIPTION

Returns:

DESCRIPTION

Return type:

TYPE

update_time_period()

update time period from the channels

mt_metadata.timeseries.software module

Created on Wed Dec 23 21:30:36 2020

copyright:

Jared Peacock (jpeacock@usgs.gov)

license:

MIT

class mt_metadata.timeseries.software.Software(**kwargs)

Bases: Base

Metadata Key	Description	Example
author Required: True Units: None Type: string Style: free form Default: None	Author of the software	Neo
version Required: True Units: None Type: string Style: free form Default: None	Software version	12.01a
last_updated Required: False Units: None Type: string Style: date Default: 1980-01-01T00:00:00+00:00	Most recent date the software was updated. Prefer to use version, but this works for non-versioned software.	2020-01-01
name Required: True Units: None Type: string Style: free form Default: None	Software name	mtrules

property author

mt_metadata.timeseries.station module

Created on Wed Dec 23 21:30:36 2020

copyright:

Jared Peacock (jpeacock@usgs.gov)

license:

MIT

class mt_metadata.timeseries.station.Station(**kwargs)

Bases: Base

Metadata Key	Description	Example
channel_layout Required: False Units: None Type: string Style: controlled vocabulary Default: None	How the station channels were laid out.	x
channels_recorded Required: True Units: None Type: string Style: name list Default: []	List of components recorded by the station. Should be a summary of all channels recorded. Dropped channels will be recorded in Run metadata.	“[ Ex, Ey, Hx, Hy, Hz, T]”
comments Required: False Units: None Type: string Style: free form Default: None	Any comments on the station.	5 runs
data_type Required: True Units: None Type: string Style: controlled vocabulary Default: BBMT	Type of data recorded. If multiple types input as a comma separated list.	BBMT
geographic_name Required: True Units: None Type: string Style: free form Default: None	Closest geographic name to the station, usually a city, but could be another common geographic location.	“Whitehorse, YK”
id Required: True Units: None Type: string Style: alpha numeric Default: None	Station ID name. This should be an alpha numeric name that is typically 5-6 characters long. Commonly the project name in 2 or 3 letters and the station number.	MT001
run_list Required: True Units: None Type: string Style: name list Default: []	List of runs recorded by the station. Should be a summary of all runs recorded.	“[ mt001a, mt001b, mt001c ]”
fdsn.id Required: False Units: None Type: string Style: alpha numeric Default: None	Given FDSN archive ID name.	MT001
fdsn.network Required: False Units: None Type: string Style: alpha numeric Default: None	Given two character FDSN archive network code.	EM
fdsn.channel_code Required: False Units: None Type: string Style: alpha numeric Default: None	Three character FDSN channel code. http://docs.fdsn.org/projects/source- identifiers/en/v1.0/channel-codes.html	LQN
fdsn.new_epoch Required: False Units: None Type: boolean Style: name Default: None	Boolean telling if a new epoch needs to be created or not.	False
fdsn.alternate_code Required: False Units: None Type: string Style: free form Default: None	Alternate Code	_INT-NON_FDSN,. UNRESTRICTED,_U S-ALL,_US- MT,_US-MT-TA
fdsn.alternate_network_code Required: False Units: None Type: string Style: free form Default: None	Alternate Network Code	_INT-NON_FDSN,. UNRESTRICTED,_U S-ALL,_US- MT,_US-MT-TA
location.latitude Required: True Units: degrees Type: float Style: number Default: 0.0	latitude of location in datum specified at survey level	23.134
location.longitude Required: True Units: degrees Type: float Style: number Default: 0.0	longitude of location in datum specified at survey level	14.23
location.elevation Required: True Units: meters Type: float Style: number Default: 0.0	elevation of location in datum specified at survey level	123.4
location.latitude_uncertainty Required: False Units: degrees Type: float Style: number Default: None	uncertainty in latitude estimation in degrees	0.01
location.longitude_uncertainty Required: False Units: degrees Type: float Style: number Default: None	uncertainty in longitude estimation in degrees	0.01
location.elevation_uncertainty Required: False Units: meters Type: float Style: number Default: None	uncertainty in elevation estimation	0.01
location.datum Required: False Units: None Type: string Style: controlled vocabulary Default: None	Datum of the location values. Usually a well known datum like WGS84.	WGS84
location.x Required: False Units: meters Type: float Style: number Default: None	relative distance to the center of the station	10.0
location.x2 Required: False Units: meters Type: float Style: number Default: None	relative distance to the center of the station	10.0
location.y Required: False Units: meters Type: float Style: number Default: None	relative distance to the center of the station	10.0
location.y2 Required: False Units: meters Type: float Style: number Default: None	relative distance to the center of the station	10.0
location.z Required: False Units: meters Type: float Style: number Default: None	relative elevation to the center of the station	10.0
location.z2 Required: False Units: meters Type: float Style: number Default: None	relative elevation to the center of the station	10.0
location.x_uncertainty Required: False Units: meters Type: float Style: number Default: None	uncertainty in longitude estimation in x-direction	0.01
location.y_uncertainty Required: False Units: meters Type: float Style: number Default: None	uncertainty in longitude estimation in y-direction	0.01
location.z_uncertainty Required: False Units: meters Type: float Style: number Default: None	uncertainty in longitude estimation in z-direction	0.01
location.declination.comments Required: False Units: None Type: string Style: free form Default: None	any comments on declination	estimated from WMM 2016
location.declination.model Required: True Units: None Type: string Style: controlled vocabulary Default: WMM	geomagnetic reference model used to calculate declination	WMM
location.declination.epoch Required: False Units: None Type: string Style: free form Default: None	Epoch for which declination was approximated in.	2020
location.declination.value Required: True Units: degrees Type: float Style: number Default: 0.0	declination angle relative to geographic north positive clockwise	12.3
location.country Required: False Units: None Type: string Style: name list Default: None	Country of the geographic location, should be spelled out in full. Can be a list of countries.	United States of America
location.state Required: False Units: None Type: string Style: name list Default: None	State or province of the geographic location, should be spelled out in full. Can be a list of states or provinces.	[Colorado, Utah]
location.county Required: False Units: None Type: string Style: name list Default: None	County of the geographic location, should be spelled out in full. Can be a list of counties.	[Douglass, Fayet]
location.township Required: False Units: None Type: string Style: free form Default: None	Township or city name or code.	090
location.section Required: False Units: None Type: string Style: free form Default: None	Section name or code.	012
location.quarter Required: False Units: None Type: string Style: free form Default: None	Quarter section code.	400
location.parcel Required: False Units: None Type: string Style: free form Default: None	Land parcel ID.	46b29a
acquired_by.name Required: True Units: None Type: string Style: free form Default: none	Persons name, should be full first and last name.	person name
acquired_by.organization Required: False Units: None Type: string Style: free form Default: None	Organization full name	mt gurus
acquired_by.comments Required: False Units: None Type: string Style: email Default: None	Any comments about the person	expert digger
orientation.method Required: True Units: None Type: string Style: controlled vocabulary Default: None	method for orienting station layout	compass
orientation.reference_frame Required: True Units: None Type: string Style: controlled vocabulary Default: geographic	“Reference frame for station layout. There are only 2 options geographic and geomagnetic. Both assume a right-handed coordinate system with North=0 E=90 and vertical positive downward”	geomagnetic
orientation.angle_to_geographic_north Required: False Units: degrees Type: float Style: number Default: None	“Angle to rotate the data to align with geographic north. If this number is 0 then it is assumed the data are aligned with geographic north in a right handed coordinate system.”	geomagnetic
orientation.value Required: False Units: None Type: string Style: controlled vocabulary Default: None	“Channel orientation relative to each other”	orthogonal
provenance.creation_time Required: True Units: None Type: string Style: date time Default: 1980-01-01T00:00:00+00:00	Date and time the file was created.	2020-02-08T12:2 3:40.324600+00: 00
provenance.comments Required: False Units: None Type: string Style: free form Default: None	Any comments on provenance of the data.	all good
provenance.log Required: False Units: None Type: string Style: free form Default: None	A history of changes made to the data.	2020-02-10T14:2 4:45+00:00 updated metadata
provenance.creator.name Required: True Units: None Type: string Style: free form Default: None	Persons name, should be full first and last name.	person name
provenance.creator.author Required: False Units: None Type: string Style: free form Default: None	Persons name, should be full first and last name.	person name
provenance.creator.organization Required: False Units: None Type: string Style: free form Default: None	Organization full name	mt gurus
provenance.creator.email Required: False Units: None Type: string Style: email Default: None	Email of the contact person	mt.guru@em.org
provenance.creator.url Required: False Units: None Type: string Style: free form Default: None	URL of the contact person	em.org
provenance.creator.comments Required: False Units: None Type: string Style: email Default: None	Any comments about the person	expert digger
provenance.submitter.name Required: True Units: None Type: string Style: free form Default: None	Persons name, should be full first and last name.	person name
provenance.submitter.author Required: False Units: None Type: string Style: free form Default: None	Persons name, should be full first and last name.	person name
provenance.submitter.organization Required: True Units: None Type: string Style: free form Default: None	Organization full name	mt gurus
provenance.submitter.email Required: True Units: None Type: string Style: email Default: None	Email of the contact person	mt.guru@em.org
provenance.submitter.url Required: False Units: None Type: string Style: free form Default: None	URL of the contact person	em.org
provenance.submitter.comments Required: False Units: None Type: string Style: email Default: None	Any comments about the person	expert digger
provenance.archive.name Required: True Units: None Type: string Style: free form Default: None	Persons name, should be full first and last name.	person name
provenance.archive.author Required: False Units: None Type: string Style: free form Default: None	Persons name, should be full first and last name.	person name
provenance.archive.organization Required: False Units: None Type: string Style: free form Default: None	Organization full name	mt gurus
provenance.archive.email Required: False Units: None Type: string Style: email Default: None	Email of the contact person	mt.guru@em.org
provenance.archive.url Required: False Units: None Type: string Style: free form Default: None	URL of the contact person	em.org
provenance.archive.comments Required: False Units: None Type: string Style: email Default: None	Any comments about the person	expert digger
provenance.software.author Required: True Units: None Type: string Style: free form Default: None	Author of the software	Neo
provenance.software.version Required: True Units: None Type: string Style: free form Default: None	Software version	12.01a
provenance.software.last_updated Required: False Units: None Type: string Style: date Default: 1980-01-01T00:00:00+00:00	Most recent date the software was updated. Prefer to use version, but this works for non-versioned software.	2020-01-01
provenance.software.name Required: True Units: None Type: string Style: free form Default: None	Software name	mtrules
time_period.end Required: True Units: None Type: string Style: time Default: 1980-01-01T00:00:00+00:00	End date and time of collection in UTC.	2020-02-04T16:2 3:45.453670+00: 00
time_period.start Required: True Units: None Type: string Style: time Default: 1980-01-01T00:00:00+00:00	Start date and time of collection in UTC.	2020-02-01T09:2 3:45.453670+00: 00
release_license Required: False Units: None Type: string Style: controlled vocabulary Default: CC0-1.0	How the data can be used. The options are based on https://github.com/spdx/license- list-data	CC BY
doi Required: False Units: None Type: string Style: url Default: none	full url of the doi number	http://doi.###

add_run(run_obj, update=True)

Add a run, if one of the same name exists overwrite it.

Parameters:

run_obj (mt_metadata.timeseries.Run) – run object to add

property channels_recorded

A list of all channels recorded

Returns:

list of all unique channels recorded for the station

Return type:

list

get_run(run_id)

Get a mt_metadata.timeseries.Run object from the given id

Parameters:

run_id (string) – run id verbatim

has_run(run_id)

Check to see if the run id already exists

Parameters:

run_id (string) – run id verbatim

Returns:

Tru if exists, False if not

Return type:

boolean

remove_run(run_id, update=True)

remove a run from the survey

Parameters:

run_id (string) – run id verbatim

run_index(run_id)

Get the index of the run_id

Parameters:

run_id (string) – run id verbatim

Returns:

index of the run

Return type:

integer

property run_list

Return names of run in survey

property runs

Return run list

update_time_period()

update time period from run information

mt_metadata.timeseries.survey module

Created on Wed Dec 23 21:30:36 2020

copyright:

Jared Peacock (jpeacock@usgs.gov)

license:

MIT

class mt_metadata.timeseries.survey.Survey(**kwargs)

Bases: Base

Metadata Key	Description	Example
id Required: True Units: None Type: string Style: alpha numeric Default: None	Alpha numeric ID that will be unique for archiving.	EMT20
comments Required: False Units: None Type: string Style: free form Default: None	Any comments about the survey.	long survey
datum Required: True Units: None Type: string Style: controlled vocabulary Default: WGS84	Datum of latitude and longitude coordinates. Should be a well-known datum, such as WGS84, and will be the reference datum for all locations. This is important for the user, they need to make sure all coordinates in the survey and child items (i.e. stations, channels) are referenced to this datum.	WGS84
geographic_name Required: True Units: None Type: string Style: free form Default: None	Closest geographic reference to survey, usually a city but could be a landmark or some other common geographic reference point.	Yukon
name Required: True Units: None Type: string Style: free form Default: None	Descriptive name of the survey.	MT Characteriza tion of Yukon Terrane
project Required: True Units: None Type: string Style: free form Default: None	Alpha numeric name for the project e.g USGS- GEOMAG.	YUTOO
summary Required: True Units: None Type: string Style: free form Default: None	Summary paragraph of survey including the purpose; difficulties; data quality; summary of outcomes if the data have been processed and modeled.	long project of characterizing mineral resources in Yukon
time_period.end_date Required: True Units: None Type: string Style: date Default: 1980-01-01	End date of the survey in UTC.	1995-01-01
time_period.start_date Required: True Units: None Type: string Style: date Default: 1980-01-01	Start date of the survey in UTC.	1/2/2020
fdsn.id Required: False Units: None Type: string Style: alpha numeric Default: None	Given FDSN archive ID name.	MT001
fdsn.network Required: False Units: None Type: string Style: alpha numeric Default: None	Given two character FDSN archive network code.	EM
fdsn.channel_code Required: False Units: None Type: string Style: alpha numeric Default: None	Three character FDSN channel code. http://docs.fdsn.org/projects/source- identifiers/en/v1.0/channel-codes.html	LQN
fdsn.new_epoch Required: False Units: None Type: boolean Style: name Default: None	Boolean telling if a new epoch needs to be created or not.	False
fdsn.alternate_code Required: False Units: None Type: string Style: free form Default: None	Alternate Code	_INT-NON_FDSN,. UNRESTRICTED,_U S-ALL,_US- MT,_US-MT-TA
fdsn.alternate_network_code Required: False Units: None Type: string Style: free form Default: None	Alternate Network Code	_INT-NON_FDSN,. UNRESTRICTED,_U S-ALL,_US- MT,_US-MT-TA
acquired_by.author Required: False Units: None Type: string Style: free form Default: None	Persons name, should be full first and last name.	person name
acquired_by.organization Required: False Units: None Type: string Style: free form Default: None	Organization full name	mt gurus
acquired_by.comments Required: False Units: None Type: string Style: email Default: None	Any comments about the person	expert digger
funding_source.name Required: False Units: None Type: string Style: name list Default: None	Persons name, should be full first and last name.	person name
funding_source.organization Required: False Units: None Type: string Style: name list Default: None	Organization full name	mt gurus
funding_source.email Required: False Units: None Type: string Style: name list Default: None	Email of the contact person	mt.guru@em.org
funding_source.url Required: False Units: None Type: string Style: name list Default: None	URL of the contact person	em.org
funding_source.comments Required: False Units: None Type: string Style: free form Default: None	Any comments about the person	expert digger
funding_source.grant_id Required: False Units: None Type: string Style: name list Default: None	Grant ID number or name	MT-01-2020
citation_dataset.doi Required: True Units: None Type: string Style: url Default: none	full url of the doi number	http://doi.###
citation_dataset.authors Required: False Units: None Type: string Style: free form Default: None	author names	M.Tee A. Roura
citation_dataset.title Required: False Units: None Type: string Style: free form Default: None	Full title of the citation	Paper Title
citation_dataset.year Required: False Units: None Type: string Style: date Default: 1980-01-01T00:00:00+00:00	Year of citation	2020
citation_dataset.volume Required: False Units: None Type: string Style: free form Default: None	Journal volume of the citation	12
citation_dataset.pages Required: False Units: None Type: string Style: free form Default: None	Page numbers of the citation	10-15
citation_dataset.journal Required: False Units: None Type: string Style: free form Default: None	Journal title of citation	Journal of Geophysical Research
citation_journal.doi Required: True Units: None Type: string Style: url Default: none	full url of the doi number	http://doi.###
citation_journal.authors Required: False Units: None Type: string Style: free form Default: None	author names	M.Tee A. Roura
citation_journal.title Required: False Units: None Type: string Style: free form Default: None	Full title of the citation	Paper Title
citation_journal.year Required: False Units: None Type: string Style: date Default: 1980-01-01T00:00:00+00:00	Year of citation	2020
citation_journal.volume Required: False Units: None Type: string Style: free form Default: None	Journal volume of the citation	12
citation_journal.pages Required: False Units: None Type: string Style: free form Default: None	Page numbers of the citation	10-15
citation_journal.journal Required: False Units: None Type: string Style: free form Default: None	Journal title of citation	Journal of Geophysical Research
northwest_corner.latitude Required: True Units: degrees Type: float Style: number Default: 0.0	latitude of location in datum specified at survey level	23.134
northwest_corner.longitude Required: True Units: degrees Type: float Style: number Default: 0.0	longitude of location in datum specified at survey level	14.23
southeast_corner.latitude Required: True Units: degrees Type: float Style: number Default: 0.0	latitude of location in datum specified at survey level	23.134
southeast_corner.longitude Required: True Units: degrees Type: float Style: number Default: 0.0	longitude of location in datum specified at survey level	14.23
country Required: False Units: None Type: string Style: name list Default: None	Country of the geographic location, should be spelled out in full. Can be a list of countries.	United States of America
state Required: False Units: None Type: string Style: name list Default: None	State or province of the geographic location, should be spelled out in full. Can be a list of states or provinces.	[Colorado, Utah]
project_lead.author Required: False Units: None Type: string Style: free form Default: None	Persons name, should be full first and last name.	person name
project_lead.organization Required: True Units: None Type: string Style: free form Default: None	Organization full name	mt gurus
project_lead.email Required: True Units: None Type: string Style: email Default: None	Email of the contact person	mt.guru@em.org
release_license Required: True Units: None Type: string Style: controlled vocabulary Default: CC0-1.0	How the data can be used. The options are based on https://github.com/spdx/license- list-data	CC BY

add_station(station_obj, update=True)

Add a station, if has the same name update that object.

Parameters:

station_obj (:class:`mt_metadata.timeseries.Station) – station object to add

property filter_names

return a list of filter names

property filters

A dictionary of available filters

get_station(station_id)

Get a station from the station id

Parameters:

station_id (string) – station id verbatim

Returns:

station object

Return type:

mt_metadata.timeseries.Station

has_station(station_id)

Has station id

Parameters:

station_id (string) – station id verbatim

Returns:

True if exists or False if not

Return type:

boolean

remove_station(station_id, update=True)

remove a station from the survey

Parameters:

station_id (string) – station id verbatim

station_index(station_id)

Get station index

Parameters:

station_id (string) – station id verbatim

Returns:

index value if station is found

Return type:

integer

property station_names

Return names of station in survey

property stations

Return station list

update_bounding_box()

Update the bounding box of the survey from the station information

update_time_period()

Update the start and end time of the survey based on the stations

mt_metadata.timeseries.time_period module

Created on Wed Dec 23 21:30:36 2020

copyright:

Jared Peacock (jpeacock@usgs.gov)

license:

MIT

class mt_metadata.timeseries.time_period.TimePeriod(**kwargs)

Bases: Base

Metadata Key	Description	Example
end Required: True Units: None Type: string Style: time Default: 1980-01-01T00:00:00+00:00	End date and time of collection in UTC.	2020-02-04T16:2 3:45.453670+00: 00
start Required: True Units: None Type: string Style: time Default: 1980-01-01T00:00:00+00:00	Start date and time of collection in UTC.	2020-02-01T09:2 3:45.453670+00: 00

property end

property end_date

property start

property start_date

mt_metadata.timeseries.timing_system module

Created on Wed Dec 23 21:30:36 2020

copyright:

Jared Peacock (jpeacock@usgs.gov)

license:

MIT

class mt_metadata.timeseries.timing_system.TimingSystem(**kwargs)

Bases: Base

Metadata Key	Description	Example
comments Required: False Units: None Type: string Style: free form Default: None	Any comment on the timing system.	GPS locked with internal quartz clock
drift Required: True Units: seconds Type: float Style: number Default: 0.0	Estimated drift of the timing system.	0.001
type Required: True Units: None Type: string Style: free form Default: GPS	Type of timing system.	GPS
uncertainty Required: True Units: seconds Type: float Style: number Default: 0.0	Estimated uncertainty of the timing system.	0.0002
n_satellites Required: False Units: None Type: integer Style: number Default: None	Number of satellites used for timing.	6

Module contents

time series metadata

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

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?

Because a lot of the name words in the metadata are split by ‘.’ there are some issues we need to deal with. I wrote in get and set attribute functions to handle these types of names so the user shouldn’t have to work about splitting the names themselves.

These containers will be the building blocks for the metadata and how they are interchanged between the HDF5 file and the user. A lot of the metadata you can get directly from the raw time series files, but the user will need to input a decent amount on their own. Dictionaries are the most fundamental type we should be dealing with.

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.

self._attr_dict = {‘nameword’:{‘type’: str, ‘required’: True, ‘style’: ‘name’}}

Created on Sun Apr 24 20:50:41 2020

copyright:

Jared Peacock (jpeacock@usgs.gov)

license:

MIT

class mt_metadata.timeseries.Auxiliary(**kwargs)

Bases: Channel

Metadata Key	Description	Example
channel_number Required: True Units: None Type: integer Style: number Default: 0	Channel number on the data logger.	1
channel_id Required: False Units: None Type: string Style: free form Default: None	channel id given by the user or data logger	1001.11
comments Required: False Units: None Type: string Style: free form Default: None	Any comments about the channel.	ambient air temperature was chilly, ice on cables
component Required: True Units: None Type: string Style: controlled vocabulary Default: None	Name of the component measured, can be uppercase and/or lowercase. For now electric channels should start with an ‘e’ and magnetic channels start with an ‘h’, followed by the component. If there are multiples of the same channel the name could include an integer. {type}{component}{number} –> Ex01.	T
measurement_azimuth Required: True Units: degrees Type: float Style: number Default: 0.0	Horizontal azimuth of the channel in measurement coordinate system spcified in station.orientation.reference_frame. Default reference frame is a geographic right-handed coordinate system with north=0, east=90, vertical=+ downward.	0
measurement_tilt Required: True Units: degrees Type: float Style: number Default: 0.0	Vertical tilt of the channel in measurement coordinate system specified in station.orientation.reference_frame. Default reference frame is a geographic right-handed coordinate system with north=0, east=90, vertical=+ downward.	0
sample_rate Required: True Units: samples per second Type: float Style: number Default: 0.0	Digital sample rate	8
translated_azimuth Required: False Units: degrees Type: float Style: number Default: None	Horizontal azimuth of the channel in translated coordinate system, this should only be used for derived product. For instance if you collected your data in geomagnetic coordinates and then translated them to geographic coordinates you would set measurement_azimuth=0, translated_azimuth=-12.5 for a declination angle of N12.5E. angle of N12.5E.	0
translated_tilt Required: False Units: degrees Type: float Style: number Default: None	Tilt of channel in translated coordinate system, this should only be used for derived product. For instance if you collected your data using a tripod you would set measurement_tilt=45, translated_tilt=0 for a vertical component.	0
type Required: True Units: None Type: string Style: free form Default: None	Data type for the channel, should be a descriptive word that a user can understand.	temperature
units Required: True Units: None Type: string Style: controlled vocabulary Default: None	Units of the data, should be in SI units and represented as the full name of the unit all lowercase. If a complex unit use ‘per’ and ‘-‘.	celsius

class mt_metadata.timeseries.Battery(**kwargs)

Bases: Base

Metadata Key	Description	Example
type Required: False Units: None Type: string Style: name Default: None	Description of battery type.	pb-acid gel cell
id Required: False Units: None Type: string Style: name Default: None	battery id	battery01
voltage.start Required: False Units: None Type: float Style: number Default: None	Starting value of a diagnostic measurement.	12.3
voltage.end Required: False Units: None Type: float Style: number Default: None	Ending value of a diagnostic measurement.	10
comments Required: False Units: None Type: string Style: name Default: None	Any comments about the battery.	discharged too quickly

class mt_metadata.timeseries.Channel(**kwargs)

Bases: Base

Metadata Key	Description	Example
channel_number Required: True Units: None Type: integer Style: number Default: 0	Channel number on the data logger.	1
channel_id Required: False Units: None Type: string Style: free form Default: None	channel id given by the user or data logger	1001.11
comments Required: False Units: None Type: string Style: free form Default: None	Any comments about the channel.	ambient air temperature was chilly, ice on cables
component Required: True Units: None Type: string Style: controlled vocabulary Default: None	Name of the component measured, can be uppercase and/or lowercase. For now electric channels should start with an ‘e’ and magnetic channels start with an ‘h’, followed by the component. If there are multiples of the same channel the name could include an integer. {type}{component}{number} –> Ex01.	T
measurement_azimuth Required: True Units: degrees Type: float Style: number Default: 0.0	Horizontal azimuth of the channel in measurement coordinate system spcified in station.orientation.reference_frame. Default reference frame is a geographic right-handed coordinate system with north=0, east=90, vertical=+ downward.	0
measurement_tilt Required: True Units: degrees Type: float Style: number Default: 0.0	Vertical tilt of the channel in measurement coordinate system specified in station.orientation.reference_frame. Default reference frame is a geographic right-handed coordinate system with north=0, east=90, vertical=+ downward.	0
sample_rate Required: True Units: samples per second Type: float Style: number Default: 0.0	Digital sample rate	8
translated_azimuth Required: False Units: degrees Type: float Style: number Default: None	Horizontal azimuth of the channel in translated coordinate system, this should only be used for derived product. For instance if you collected your data in geomagnetic coordinates and then translated them to geographic coordinates you would set measurement_azimuth=0, translated_azimuth=-12.5 for a declination angle of N12.5E. angle of N12.5E.	0
translated_tilt Required: False Units: degrees Type: float Style: number Default: None	Tilt of channel in translated coordinate system, this should only be used for derived product. For instance if you collected your data using a tripod you would set measurement_tilt=45, translated_tilt=0 for a vertical component.	0
type Required: True Units: None Type: string Style: free form Default: None	Data type for the channel, should be a descriptive word that a user can understand.	temperature
units Required: True Units: None Type: string Style: controlled vocabulary Default: None	Units of the data, should be in SI units and represented as the full name of the unit all lowercase. If a complex unit use ‘per’ and ‘-‘.	celsius
data_quality.warnings Required: False Units: None Type: string Style: free form Default: None	any warnings about the data that should be noted	periodic pipeline noise
data_quality.good_from_period Required: False Units: None Type: float Style: number Default: None	Data are good for periods larger than this number	0.01
data_quality.good_to_period Required: False Units: None Type: float Style: number Default: None	Data are good for periods smaller than this number	1000
data_quality.flag Required: False Units: None Type: integer Style: number Default: None	Flag for data quality	0
data_quality.comments Required: False Units: None Type: string Style: free form Default: None	any comments about the data quality	0
data_quality.rating.author Required: False Units: None Type: string Style: free form Default: None	Author of who rated the data.	gradstudent ace
data_quality.rating.method Required: False Units: None Type: string Style: free form Default: None	The method used to rate the data.	standard deviation
data_quality.rating.value Required: True Units: None Type: integer Style: number Default: 0	A rating from 1-5 where 1 is bad and 5 is good and 0 if unrated.	4
filter.name Required: True Units: None Type: string Style: name list Default: []	Name of filter applied or to be applied. If more than one filter input as a comma separated list.	“[counts2mv, lo wpass_magnetic] “
filter.applied Required: True Units: None Type: boolean Style: name list Default: []	Boolean if filter has been applied or not. If more than one filter input as a comma separated list. Needs to be the same length as name or if only one entry is given it is assumed to apply to all filters listed.	“[True, False]”
filter.comments Required: False Units: None Type: string Style: name Default: None	Any comments on filters.	low pass is not calibrated
time_period.end Required: True Units: None Type: string Style: time Default: 1980-01-01T00:00:00+00:00	End date and time of collection in UTC.	2020-02-04T16:2 3:45.453670+00: 00
time_period.start Required: True Units: None Type: string Style: time Default: 1980-01-01T00:00:00+00:00	Start date and time of collection in UTC.	2020-02-01T09:2 3:45.453670+00: 00
sensor.id Required: True Units: None Type: string Style: free form Default: none	Instrument ID number can be serial number or a designated ID.	mt01
sensor.manufacturer Required: True Units: None Type: string Style: free form Default: none	Who manufactured the instrument.	mt gurus
sensor.type Required: True Units: None Type: string Style: free form Default: none	Description of the instrument type.	broadband 32-bit
sensor.model Required: False Units: None Type: string Style: free form Default: None	Model version of the instrument.	falcon5
sensor.name Required: False Units: None Type: string Style: free form Default: None	Standard marketing name of the instrument.	falcon5
fdsn.id Required: False Units: None Type: string Style: alpha numeric Default: None	Given FDSN archive ID name.	MT001
fdsn.network Required: False Units: None Type: string Style: alpha numeric Default: None	Given two character FDSN archive network code.	EM
fdsn.channel_code Required: False Units: None Type: string Style: alpha numeric Default: None	Three character FDSN channel code. http://docs.fdsn.org/projects/source- identifiers/en/v1.0/channel-codes.html	LQN
fdsn.new_epoch Required: False Units: None Type: boolean Style: name Default: None	Boolean telling if a new epoch needs to be created or not.	False
fdsn.alternate_code Required: False Units: None Type: string Style: free form Default: None	Alternate Code	_INT-NON_FDSN,. UNRESTRICTED,_U S-ALL,_US- MT,_US-MT-TA
fdsn.alternate_network_code Required: False Units: None Type: string Style: free form Default: None	Alternate Network Code	_INT-NON_FDSN,. UNRESTRICTED,_U S-ALL,_US- MT,_US-MT-TA
location.latitude Required: True Units: degrees Type: float Style: number Default: 0.0	latitude of location in datum specified at survey level	23.134
location.longitude Required: True Units: degrees Type: float Style: number Default: 0.0	longitude of location in datum specified at survey level	14.23
location.elevation Required: True Units: meters Type: float Style: number Default: 0.0	elevation of location in datum specified at survey level	123.4

channel_response(filters_dict)

full channel response from a dictionary of filter objects

property component

property unit_object

class mt_metadata.timeseries.Citation(**kwargs)

Bases: Base

Metadata Key	Description	Example
doi Required: True Units: None Type: string Style: url Default: None	full url of the doi number	http://doi.###
authors Required: False Units: None Type: string Style: free form Default: None	author names	M.Tee A. Roura
title Required: False Units: None Type: string Style: free form Default: None	Full title of the citation	Paper Title
year Required: False Units: None Type: string Style: date Default: 1980-01-01T00:00:00+00:00	Year of citation	2020
volume Required: False Units: None Type: string Style: free form Default: None	Journal volume of the citation	12
pages Required: False Units: None Type: string Style: free form Default: None	Page numbers of the citation	10-15
journal Required: False Units: None Type: string Style: free form Default: None	Journal title of citation	Journal of Geophysical Research

class mt_metadata.timeseries.Copyright(**kwargs)

Bases: Base

Metadata Key	Description	Example
release_license Required: True Units: None Type: string Style: controlled vocabulary Default: CC0-1.0	How the data can be used. The options are based on https://github.com/spdx/license- list-data	CC BY

class mt_metadata.timeseries.DataLogger(**kwargs)

Bases: Base

Metadata Key	Description	Example
id Required: True Units: None Type: string Style: free form Default: None	Instrument ID number can be serial number or a designated ID.	mt01
manufacturer Required: True Units: None Type: string Style: free form Default: None	Who manufactured the instrument.	mt gurus
type Required: True Units: None Type: string Style: free form Default: None	Description of the instrument type.	broadband 32-bit
model Required: False Units: None Type: string Style: free form Default: None	Model version of the instrument.	falcon5
name Required: False Units: None Type: string Style: free form Default: None	Standard marketing name of the instrument.	falcon5
timing_system.comments Required: False Units: None Type: string Style: free form Default: None	Any comment on the timing system.	GPS locked with internal quartz clock
timing_system.drift Required: True Units: seconds Type: float Style: number Default: 0.0	Estimated drift of the timing system.	0.001
timing_system.type Required: True Units: None Type: string Style: free form Default: GPS	Type of timing system.	GPS
timing_system.uncertainty Required: True Units: seconds Type: float Style: number Default: 0.0	Estimated uncertainty of the timing system.	0.0002
timing_system.n_satellites Required: False Units: None Type: integer Style: number Default: None	Number of satellites used for timing.	6
firmware.author Required: True Units: None Type: string Style: free form Default: none	Author of the software	Neo
firmware.version Required: True Units: None Type: string Style: free form Default: none	Software version	12.01a
firmware.last_updated Required: False Units: None Type: string Style: date Default: 1980-01-01T00:00:00+00:00	Most recent date the software was updated. Prefer to use version, but this works for non-versioned software.	2020-01-01
firmware.name Required: True Units: None Type: string Style: free form Default: none	Software name	mtrules
power_source.type Required: False Units: None Type: string Style: name Default: None	Description of battery type.	pb-acid gel cell
power_source.id Required: False Units: None Type: string Style: name Default: None	battery id	battery01
power_source.voltage.start Required: False Units: volts Type: float Style: number Default: None	Starting voltage	14.3
power_source.voltage.end Required: False Units: volts Type: float Style: number Default: None	Ending voltage	12.1
power_source.comments Required: False Units: None Type: string Style: name Default: None	Any comments about the battery.	discharged too quickly
data_storage.id Required: False Units: None Type: string Style: free form Default: none	Instrument ID number can be serial number or a designated ID.	mt01
data_storage.manufacturer Required: False Units: None Type: string Style: free form Default: none	Who manufactured the instrument.	mt gurus
data_storage.type Required: False Units: None Type: string Style: free form Default: none	Description of the instrument type.	broadband 32-bit
data_storage.model Required: False Units: None Type: string Style: free form Default: None	Model version of the instrument.	falcon5
data_storage.name Required: False Units: None Type: string Style: free form Default: None	Standard marketing name of the instrument.	falcon5

class mt_metadata.timeseries.DataQuality(**kwargs)

Bases: Base

Metadata Key	Description	Example
warnings Required: False Units: None Type: string Style: free form Default: None	any warnings about the data that should be noted	periodic pipeline noise
good_from_period Required: False Units: None Type: float Style: number Default: None	Data are good for periods larger than this number	0.01
good_to_period Required: False Units: None Type: float Style: number Default: None	Data are good for periods smaller than this number	1000
flag Required: False Units: None Type: integer Style: number Default: None	Flag for data quality	0
comments Required: False Units: None Type: string Style: free form Default: None	any comments about the data quality	0
rating.author Required: False Units: None Type: string Style: free form Default: None	Author of who rated the data.	gradstudent ace
rating.method Required: False Units: None Type: string Style: free form Default: None	The method used to rate the data.	standard deviation
rating.value Required: True Units: None Type: integer Style: number Default: 0	A rating from 1-5 where 1 is bad and 5 is good and 0 if unrated.	4

class mt_metadata.timeseries.Declination(**kwargs)

Bases: Base

Metadata Key	Description	Example
comments Required: False Units: None Type: string Style: free form Default: None	any comments on declination	estimated from WMM 2016
model Required: True Units: None Type: string Style: controlled vocabulary Default: WMM	geomagnetic reference model used to calculate declination	WMM
epoch Required: False Units: None Type: string Style: free form Default: None	Epoch for which declination was approximated in.	2020
value Required: True Units: degrees Type: float Style: number Default: 0.0	declination angle relative to geographic north positive clockwise	12.3

class mt_metadata.timeseries.Diagnostic(**kwargs)

Bases: Base

Metadata Key	Description	Example
end Required: False Units: None Type: float Style: number Default: None	Ending value of a diagnostic measurement.	10
start Required: False Units: None Type: float Style: number Default: None	Starting value of a diagnostic measurement.	12.3

class mt_metadata.timeseries.Electric(**kwargs)

Bases: Channel

Metadata Key	Description	Example
dipole_length Required: True Units: meters Type: float Style: number Default: 0.0	Length of the dipole as measured in a straight line from electrode to electrode.	55.25
contact_resistance.start Required: False Units: ohms Type: float Style: number list Default: None	Starting contact resistance; if more than one measurement input as a list of number [1 2 3 …].	“[1.2, 1.4]”
contact_resistance.end Required: False Units: ohms Type: float Style: number list Default: None	Ending contact resistance; if more than one measurement input as a list of number [1 2 3 …].	“[1.5, 1.8]”
ac.start Required: False Units: volts Type: float Style: number Default: None	Starting AC value; if more than one measurement input as a list of number [1 2 3 …].	“[52.1, 55.8]”
ac.end Required: False Units: volts Type: float Style: number Default: None	Ending AC value; if more than one measurement input as a list of number [1 2 3 …].	“[45.3, 49.5]”
dc.start Required: False Units: volts Type: float Style: number Default: None	Starting DC value; if more than one measurement input as a list of number [1 2 3 …].	1.1
dc.end Required: False Units: volts Type: float Style: number Default: None	Ending DC value; if more than one measurement input as a list of number [1 2 3 …].	1.5
channel_number Required: True Units: None Type: integer Style: number Default: 0	Channel number on the data logger.	1
channel_id Required: False Units: None Type: string Style: free form Default: None	channel id given by the user or data logger	1001.11
comments Required: False Units: None Type: string Style: free form Default: None	Any comments about the channel.	ambient air temperature was chilly, ice on cables
component Required: True Units: None Type: string Style: controlled vocabulary Default: None	Name of the component measured, can be uppercase and/or lowercase. For now electric channels should start with an ‘e’ and magnetic channels start with an ‘h’, followed by the component. If there are multiples of the same channel the name could include an integer. {type}{component}{number} –> Ex01.	T
measurement_azimuth Required: True Units: degrees Type: float Style: number Default: 0.0	Horizontal azimuth of the channel in measurement coordinate system spcified in station.orientation.reference_frame. Default reference frame is a geographic right-handed coordinate system with north=0, east=90, vertical=+ downward.	0
measurement_tilt Required: True Units: degrees Type: float Style: number Default: 0.0	Vertical tilt of the channel in measurement coordinate system specified in station.orientation.reference_frame. Default reference frame is a geographic right-handed coordinate system with north=0, east=90, vertical=+ downward.	0
sample_rate Required: True Units: samples per second Type: float Style: number Default: 0.0	Digital sample rate	8
translated_azimuth Required: False Units: degrees Type: float Style: number Default: None	Horizontal azimuth of the channel in translated coordinate system, this should only be used for derived product. For instance if you collected your data in geomagnetic coordinates and then translated them to geographic coordinates you would set measurement_azimuth=0, translated_azimuth=-12.5 for a declination angle of N12.5E. angle of N12.5E.	0
translated_tilt Required: False Units: degrees Type: float Style: number Default: None	Tilt of channel in translated coordinate system, this should only be used for derived product. For instance if you collected your data using a tripod you would set measurement_tilt=45, translated_tilt=0 for a vertical component.	0
type Required: True Units: None Type: string Style: free form Default: none	Data type for the channel, should be a descriptive word that a user can understand.	temperature
units Required: True Units: None Type: string Style: controlled vocabulary Default: None	Units of the data, should be in SI units and represented as the full name of the unit all lowercase. If a complex unit use ‘per’ and ‘-‘.	celsius
data_quality.warnings Required: False Units: None Type: string Style: free form Default: None	any warnings about the data that should be noted	periodic pipeline noise
data_quality.good_from_period Required: False Units: None Type: float Style: number Default: None	Data are good for periods larger than this number	0.01
data_quality.good_to_period Required: False Units: None Type: float Style: number Default: None	Data are good for periods smaller than this number	1000
data_quality.flag Required: False Units: None Type: integer Style: number Default: None	Flag for data quality	0
data_quality.comments Required: False Units: None Type: string Style: free form Default: None	any comments about the data quality	0
data_quality.rating.author Required: False Units: None Type: string Style: free form Default: None	Author of who rated the data.	gradstudent ace
data_quality.rating.method Required: False Units: None Type: string Style: free form Default: None	The method used to rate the data.	standard deviation
data_quality.rating.value Required: True Units: None Type: integer Style: number Default: 0	A rating from 1-5 where 1 is bad and 5 is good and 0 if unrated.	4
filter.name Required: True Units: None Type: string Style: name list Default: []	Name of filter applied or to be applied. If more than one filter input as a comma separated list.	“[counts2mv, lo wpass_magnetic] “
filter.applied Required: True Units: None Type: boolean Style: name list Default: []	Boolean if filter has been applied or not. If more than one filter input as a comma separated list. Needs to be the same length as name or if only one entry is given it is assumed to apply to all filters listed.	“[True, False]”
filter.comments Required: False Units: None Type: string Style: name Default: None	Any comments on filters.	low pass is not calibrated
positive.id Required: True Units: None Type: string Style: free form Default: None	Instrument ID number can be serial number or a designated ID.	mt01
positive.manufacturer Required: True Units: None Type: string Style: free form Default: None	Who manufactured the instrument.	mt gurus
positive.type Required: True Units: None Type: string Style: free form Default: None	Description of the instrument type.	broadband 32-bit
positive.model Required: False Units: None Type: string Style: free form Default: None	Model version of the instrument.	falcon5
positive.name Required: False Units: None Type: string Style: free form Default: None	Standard marketing name of the instrument.	falcon5
positive.latitude Required: True Units: degrees Type: float Style: number Default: 0.0	latitude of location in datum specified at survey level	23.134
positive.longitude Required: True Units: degrees Type: float Style: number Default: 0.0	longitude of location in datum specified at survey level	14.23
positive.elevation Required: True Units: meters Type: float Style: number Default: 0.0	elevation of location in datum specified at survey level	123.4
positive.latitude_uncertainty Required: False Units: degrees Type: float Style: number Default: None	uncertainty in latitude estimation in degrees	0.01
positive.longitude_uncertainty Required: False Units: degrees Type: float Style: number Default: None	uncertainty in longitude estimation in degrees	0.01
positive.elevation_uncertainty Required: False Units: meters Type: float Style: number Default: None	uncertainty in elevation estimation	0.01
positive.datum Required: False Units: None Type: string Style: controlled vocabulary Default: None	Datum of the location values. Usually a well known datum like WGS84.	WGS84
positive.x Required: False Units: meters Type: float Style: number Default: None	relative distance to the center of the station	10.0
positive.x2 Required: False Units: meters Type: float Style: number Default: None	relative distance to the center of the station	10.0
positive.y Required: False Units: meters Type: float Style: number Default: None	relative distance to the center of the station	10.0
positive.y2 Required: False Units: meters Type: float Style: number Default: None	relative distance to the center of the station	10.0
positive.z Required: False Units: meters Type: float Style: number Default: None	relative elevation to the center of the station	10.0
positive.z2 Required: False Units: meters Type: float Style: number Default: None	relative elevation to the center of the station	10.0
positive.x_uncertainty Required: False Units: meters Type: float Style: number Default: None	uncertainty in longitude estimation in x-direction	0.01
positive.y_uncertainty Required: False Units: meters Type: float Style: number Default: None	uncertainty in longitude estimation in y-direction	0.01
positive.z_uncertainty Required: False Units: meters Type: float Style: number Default: None	uncertainty in longitude estimation in z-direction	0.01
negative.id Required: True Units: None Type: string Style: free form Default: None	Instrument ID number can be serial number or a designated ID.	mt01
negative.manufacturer Required: True Units: None Type: string Style: free form Default: None	Who manufactured the instrument.	mt gurus
negative.type Required: True Units: None Type: string Style: free form Default: None	Description of the instrument type.	broadband 32-bit
negative.model Required: False Units: None Type: string Style: free form Default: None	Model version of the instrument.	falcon5
negative.name Required: False Units: None Type: string Style: free form Default: None	Standard marketing name of the instrument.	falcon5
negative.latitude Required: True Units: degrees Type: float Style: number Default: 0.0	latitude of location in datum specified at survey level	23.134
negative.longitude Required: True Units: degrees Type: float Style: number Default: 0.0	longitude of location in datum specified at survey level	14.23
negative.elevation Required: True Units: meters Type: float Style: number Default: 0.0	elevation of location in datum specified at survey level	123.4
negative.latitude_uncertainty Required: False Units: degrees Type: float Style: number Default: None	uncertainty in latitude estimation in degrees	0.01
negative.longitude_uncertainty Required: False Units: degrees Type: float Style: number Default: None	uncertainty in longitude estimation in degrees	0.01
negative.elevation_uncertainty Required: False Units: meters Type: float Style: number Default: None	uncertainty in elevation estimation	0.01
negative.datum Required: False Units: None Type: string Style: controlled vocabulary Default: None	Datum of the location values. Usually a well known datum like WGS84.	WGS84
negative.x Required: False Units: meters Type: float Style: number Default: None	relative distance to the center of the station	10.0
negative.x2 Required: False Units: meters Type: float Style: number Default: None	relative distance to the center of the station	10.0
negative.y Required: False Units: meters Type: float Style: number Default: None	relative distance to the center of the station	10.0
negative.y2 Required: False Units: meters Type: float Style: number Default: None	relative distance to the center of the station	10.0
negative.z Required: False Units: meters Type: float Style: number Default: None	relative elevation to the center of the station	10.0
negative.z2 Required: False Units: meters Type: float Style: number Default: None	relative elevation to the center of the station	10.0
negative.x_uncertainty Required: False Units: meters Type: float Style: number Default: None	uncertainty in longitude estimation in x-direction	0.01
negative.y_uncertainty Required: False Units: meters Type: float Style: number Default: None	uncertainty in longitude estimation in y-direction	0.01
negative.z_uncertainty Required: False Units: meters Type: float Style: number Default: None	uncertainty in longitude estimation in z-direction	0.01
time_period.end Required: True Units: None Type: string Style: time Default: 1980-01-01T00:00:00+00:00	End date and time of collection in UTC.	2020-02-04T16:2 3:45.453670+00: 00
time_period.start Required: True Units: None Type: string Style: time Default: 1980-01-01T00:00:00+00:00	Start date and time of collection in UTC.	2020-02-01T09:2 3:45.453670+00: 00

class mt_metadata.timeseries.Electrode(**kwargs)

Bases: Base

Metadata Key	Description	Example
id Required: True Units: None Type: string Style: free form Default: None	Instrument ID number can be serial number or a designated ID.	mt01
manufacturer Required: True Units: None Type: string Style: free form Default: None	Who manufactured the instrument.	mt gurus
type Required: True Units: None Type: string Style: free form Default: None	Description of the instrument type.	broadband 32-bit
model Required: False Units: None Type: string Style: free form Default: None	Model version of the instrument.	falcon5
name Required: False Units: None Type: string Style: free form Default: None	Standard marketing name of the instrument.	falcon5
latitude Required: True Units: degrees Type: float Style: number Default: 0.0	latitude of location in datum specified at survey level	23.134
longitude Required: True Units: degrees Type: float Style: number Default: 0.0	longitude of location in datum specified at survey level	14.23
elevation Required: True Units: meters Type: float Style: number Default: 0.0	elevation of location in datum specified at survey level	123.4
x Required: False Units: meters Type: float Style: number Default: None	relative distance to the center of the station	10.0
x2 Required: False Units: meters Type: float Style: number Default: None	relative distance to the center of the station	10.0
y Required: False Units: meters Type: float Style: number Default: None	relative distance to the center of the station	10.0
y2 Required: False Units: meters Type: float Style: number Default: None	relative distance to the center of the station	10.0
z Required: False Units: meters Type: float Style: number Default: None	relative elevation to the center of the station	10.0
z2 Required: False Units: meters Type: float Style: number Default: None	relative elevation to the center of the station	10.0

class mt_metadata.timeseries.Experiment(surveys=[])

Bases: Base

Top level of the metadata

add_survey(survey_obj)

Add a survey, if has the same name update that object.

Parameters:

survey_obj (:class:`mt_metadata.timeseries.Survey) – DESCRIPTION

Returns:

DESCRIPTION

Return type:

TYPE

from_dict(ex_dict, skip_none=True)

fill from an input dictionary

Parameters:

ex_dict (TYPE) – DESCRIPTION

Returns:

DESCRIPTION

Return type:

TYPE

from_json(json_str, skip_none=True)

read in a json string and update attributes of an object

Parameters:

json_str (string or pathlib.Path) – json string or file path

from_pickle(fn)

Read pickle version of experiment

Parameters:

fn (TYPE) – DESCRIPTION

Returns:

DESCRIPTION

Return type:

TYPE

from_xml(fn=None, element=None, sort=True, skip_none=True)

Parameters:

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

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

Returns:

DESCRIPTION

Return type:

TYPE

get_survey(survey_id)

Get a survey from the survey id

Parameters:

survey_id (TYPE) – DESCRIPTION

Returns:

DESCRIPTION

Return type:

TYPE

has_survey(survey_id)

Has survey id

Parameters:

survey_id (TYPE) – DESCRIPTION

Returns:

DESCRIPTION

Return type:

TYPE

sort(inplace=True)

sort surveys, stations, runs, channels alphabetically/numerically

Parameters:

inplace (TYPE, optional) – DESCRIPTION, defaults to True

Returns:

DESCRIPTION

Return type:

TYPE

survey_index(survey_id)

Get survey index

Parameters:

survey_id (TYPE) – DESCRIPTION

Returns:

DESCRIPTION

Return type:

TYPE

property survey_names

Return names of surveys in experiment

property surveys

Return survey list

to_dict(nested=False, required=True)

create a dictionary for the experiment object.

Parameters:

• nested (TYPE, optional) – DESCRIPTION, defaults to False

• single (TYPE, optional) – DESCRIPTION, defaults to False

• required (TYPE, optional) – DESCRIPTION, defaults to True

Returns:

DESCRIPTION

Return type:

TYPE

to_json(fn=None, nested=False, indent='    ', required=True)

Write a json string from a given object, taking into account other class objects contained within the given object.

Parameters:

nested ([ True | False ] , default is False) – make the returned json nested

to_pickle(fn)

Write a pickle version of the experiment

Parameters:

fn (TYPE) – DESCRIPTION

Returns:

DESCRIPTION

Return type:

TYPE

to_xml(fn=None, required=True, sort=True)

Write XML version of the experiment

Parameters:

fn (TYPE) – DESCRIPTION

Returns:

DESCRIPTION

Return type:

TYPE

validate_experiment()

Validate experiment is legal

Returns:

DESCRIPTION

Return type:

TYPE

class mt_metadata.timeseries.Fdsn(**kwargs)

Bases: Base

Metadata Key	Description	Example
id Required: False Units: None Type: string Style: alpha numeric Default: None	Given FDSN archive ID name.	MT001
network Required: False Units: None Type: string Style: alpha numeric Default: None	Given two character FDSN archive network code.	EM
channel_code Required: False Units: None Type: string Style: alpha numeric Default: None	Three character FDSN channel code. http://docs.fdsn.org/projects/source- identifiers/en/v1.0/channel-codes.html	LQN
new_epoch Required: False Units: None Type: boolean Style: name Default: None	Boolean telling if a new epoch needs to be created or not.	False
alternate_code Required: False Units: None Type: string Style: free form Default: None	Alternate Code	_INT-NON_FDSN,. UNRESTRICTED,_U S-ALL,_US- MT,_US-MT-TA
alternate_network_code Required: False Units: None Type: string Style: free form Default: None	Alternate Network Code	_INT-NON_FDSN,. UNRESTRICTED,_U S-ALL,_US- MT,_US-MT-TA

class mt_metadata.timeseries.FilterBase(**kwargs)

Bases: Base

Metadata Key	Description	Example
name Required: True Units: None Type: string Style: name Default: None	Name of filter applied or to be applied. If more than one filter input as a comma separated list.	“lowpass_magnet ic”
comments Required: False Units: None Type: string Style: free form Default: None	Any comments about the filter.	ambient air temperature
type Required: True Units: None Type: string Style: controlled vocabulary Default: None	Type of filter, must be one of the available filters.	fap_table
units_in Required: True Units: None Type: string Style: alpha numeric Default: None	Name of the input units to the filter. Should be all lowercase and separated with an underscore, use ‘per’ if units are divided and ‘-’ if units are multiplied.	count
units_out Required: True Units: None Type: string Style: alpha numeric Default: None	Name of the output units. Should be all lowercase and separated with an underscore, use ‘per’ if units are divided and ‘-’ if units are multiplied.	millivolt
calibration_date Required: False Units: None Type: string Style: date Default: 1980-01-01T00:00:00+00:00	Most recent date of filter calibration in ISO format of YYY-MM-DD.	2020-01-01
gain Required: True Units: None Type: float Style: number Default: 1.0	scalar gain of the filter across all frequencies, producted with any frequency depenendent terms	1.0

property calibration_date

calibration date (YYYY-MM-DD) :rtype: string

Type:

return

complex_response(frqs)

property decimation_active

if decimation is prescribed :rtype: bool

Type:

return

classmethod from_obspy_stage(stage, mapping=None)

Expected to return a multiply operation function

Parameters:

• cls (filter object) – a filter object

• stage (obspy.inventory.response.ResponseStage) – Obspy stage filter

• mapping (dict, optional) – dictionary for mapping from an obspy stage, defaults to None

Raises:

TypeError – If stage is not a obspy.inventory.response.ResponseStage

Returns:

the appropriate mt_metadata.timeseries.filter object

Return type:

mt_metadata.timeseries.filter object

generate_frequency_axis(sampling_rate, n_observations)

get_filter_description()

Returns:

predetermined filter description based on the type of filter

Return type:

string

make_obspy_mapping()

property name

name of the filter :rtype: str

Type:

return

property obspy_mapping

mapping to an obspy filter :rtype: dict

Type:

return

pass_band(frequencies, window_len=5, tol=0.5, **kwargs)

Caveat: This should work for most Fluxgate and feedback coil magnetometers, and basically most filters having a “low” number of poles and zeros. This method is not 100% robust to filters with a notch in them.

Try to estimate pass band of the filter from the flattest spots in the amplitude.

The flattest spot is determined by calculating a sliding window with length window_len and estimating normalized std.

..note:: This only works for simple filters with

on flat pass band.

Parameters:

• window_len (integer) – length of sliding window in points

• tol (float) – the ratio of the mean/std should be around 1 tol is the range around 1 to find the flat part of the curve.

Returns:

pass band frequencies

Return type:

np.ndarray

plot_response(frequencies, x_units='period', unwrap=True, pb_tol=0.1, interpolation_method='slinear')

property total_gain

Total gain of the filter :rtype: float

Type:

return

property units_in

Input units of the filter :rtype: string

Type:

return

property units_out

Output units of the filter :rtype: string

Type:

return

class mt_metadata.timeseries.Filtered(**kwargs)

Bases: Base

Metadata Key	Description	Example
name Required: True Units: None Type: string Style: name list Default: []	Name of filter applied or to be applied. If more than one filter input as a comma separated list.	“[counts2mv, lo wpass_magnetic] “
applied Required: True Units: None Type: boolean Style: name list Default: []	Boolean if filter has been applied or not. If more than one filter input as a comma separated list. Needs to be the same length as name or if only one entry is given it is assumed to apply to all filters listed.	“[True, False]”
comments Required: False Units: None Type: string Style: name Default: None	Any comments on filters.	low pass is not calibrated

property applied

property name

class mt_metadata.timeseries.FundingSource(**kwargs)

Bases: Base

Metadata Key	Description	Example
name Required: False Units: None Type: string Style: name list Default: None	Persons name, should be full first and last name.	person name
organization Required: False Units: None Type: string Style: name list Default: None	Organization full name	mt gurus
email Required: False Units: None Type: string Style: name list Default: None	Email of the contact person	mt.guru@em.org
url Required: False Units: None Type: string Style: name list Default: None	URL of the contact person	em.org
comments Required: False Units: None Type: string Style: free form Default: None	Any comments about the person	expert digger
grant_id Required: False Units: None Type: string Style: name list Default: None	Grant ID number or name	MT-01-2020

class mt_metadata.timeseries.GeographicLocation(**kwargs)

Bases: Base

Metadata Key	Description	Example
country Required: False Units: None Type: string Style: name list Default: None	Country of the geographic location, should be spelled out in full. Can be a list of countries.	United States of America
state Required: False Units: None Type: string Style: name list Default: None	State or province of the geographic location, should be spelled out in full. Can be a list of states or provinces.	[Colorado, Utah]
county Required: False Units: None Type: string Style: name list Default: None	County of the geographic location, should be spelled out in full. Can be a list of counties.	[Douglass, Fayet]
township Required: False Units: None Type: string Style: free form Default: None	Township or city name or code.	090
section Required: False Units: None Type: string Style: free form Default: None	Section name or code.	012
quarter Required: False Units: None Type: string Style: free form Default: None	Quarter section code.	400
parcel Required: False Units: None Type: string Style: free form Default: None	Land parcel ID.	46b29a

class mt_metadata.timeseries.Instrument(**kwargs)

Bases: Base

Metadata Key	Description	Example
id Required: True Units: None Type: string Style: free form Default: None	Instrument ID number can be serial number or a designated ID.	mt01
manufacturer Required: True Units: None Type: string Style: free form Default: None	Who manufactured the instrument.	mt gurus
type Required: True Units: None Type: string Style: free form Default: None	Description of the instrument type.	broadband 32-bit
model Required: False Units: None Type: string Style: free form Default: None	Model version of the instrument.	falcon5
name Required: False Units: None Type: string Style: free form Default: None	Standard marketing name of the instrument.	falcon5

class mt_metadata.timeseries.Location(**kwargs)

Bases: Base

Metadata Key	Description	Example
latitude Required: True Units: degrees Type: float Style: number Default: 0.0	latitude of location in datum specified at survey level	23.134
longitude Required: True Units: degrees Type: float Style: number Default: 0.0	longitude of location in datum specified at survey level	14.23
elevation Required: True Units: meters Type: float Style: number Default: 0.0	elevation of location in datum specified at survey level	123.4
latitude_uncertainty Required: False Units: degrees Type: float Style: number Default: None	uncertainty in latitude estimation in degrees	0.01
longitude_uncertainty Required: False Units: degrees Type: float Style: number Default: None	uncertainty in longitude estimation in degrees	0.01
elevation_uncertainty Required: False Units: meters Type: float Style: number Default: None	uncertainty in elevation estimation	0.01
datum Required: False Units: None Type: string Style: controlled vocabulary Default: None	Datum of the location values. Usually a well known datum like WGS84.	WGS84
x Required: False Units: meters Type: float Style: number Default: None	relative distance to the center of the station	10.0
x2 Required: False Units: meters Type: float Style: number Default: None	relative distance to the center of the station	10.0
y Required: False Units: meters Type: float Style: number Default: None	relative distance to the center of the station	10.0
y2 Required: False Units: meters Type: float Style: number Default: None	relative distance to the center of the station	10.0
z Required: False Units: meters Type: float Style: number Default: None	relative elevation to the center of the station	10.0
z2 Required: False Units: meters Type: float Style: number Default: None	relative elevation to the center of the station	10.0
x_uncertainty Required: False Units: meters Type: float Style: number Default: None	uncertainty in longitude estimation in x-direction	0.01
y_uncertainty Required: False Units: meters Type: float Style: number Default: None	uncertainty in longitude estimation in y-direction	0.01
z_uncertainty Required: False Units: meters Type: float Style: number Default: None	uncertainty in longitude estimation in z-direction	0.01
declination.comments Required: False Units: None Type: string Style: free form Default: None	any comments on declination	estimated from WMM 2016
declination.model Required: True Units: None Type: string Style: controlled vocabulary Default: WMM	geomagnetic reference model used to calculate declination	WMM
declination.epoch Required: False Units: None Type: string Style: free form Default: None	Epoch for which declination was approximated in.	2020
declination.value Required: True Units: degrees Type: float Style: number Default: 0.0	declination angle relative to geographic north positive clockwise	12.3

property elevation

property latitude

property longitude

class mt_metadata.timeseries.Magnetic(**kwargs)

Bases: Channel

Metadata Key	Description	Example
h_field_min.start Required: False Units: nt Type: float Style: number Default: None	Minimum magnetic field strength at beginning of measurement.	40345.1
h_field_min.end Required: False Units: nt Type: float Style: number Default: None	Minimum magnetic field strength at end of measurement.	50453.2
h_field_max.start Required: False Units: nt Type: float Style: number Default: None	Maximum magnetic field strength at beginning of measurement.	34565.2
h_field_max.end Required: False Units: nt Type: float Style: number Default: None	Maximum magnetic field strength at end of measurement.	34526.1
channel_number Required: True Units: None Type: integer Style: number Default: 0	Channel number on the data logger.	1
channel_id Required: False Units: None Type: string Style: free form Default: None	channel id given by the user or data logger	1001.11
comments Required: False Units: None Type: string Style: free form Default: None	Any comments about the channel.	ambient air temperature was chilly, ice on cables
component Required: True Units: None Type: string Style: controlled vocabulary Default: None	Name of the component measured, can be uppercase and/or lowercase. For now electric channels should start with an ‘e’ and magnetic channels start with an ‘h’, followed by the component. If there are multiples of the same channel the name could include an integer. {type}{component}{number} –> Ex01.	T
measurement_azimuth Required: True Units: degrees Type: float Style: number Default: 0.0	Horizontal azimuth of the channel in measurement coordinate system spcified in station.orientation.reference_frame. Default reference frame is a geographic right-handed coordinate system with north=0, east=90, vertical=+ downward.	0
measurement_tilt Required: True Units: degrees Type: float Style: number Default: 0.0	Vertical tilt of the channel in measurement coordinate system specified in station.orientation.reference_frame. Default reference frame is a geographic right-handed coordinate system with north=0, east=90, vertical=+ downward.	0
sample_rate Required: True Units: samples per second Type: float Style: number Default: 0.0	Digital sample rate	8
translated_azimuth Required: False Units: degrees Type: float Style: number Default: None	Horizontal azimuth of the channel in translated coordinate system, this should only be used for derived product. For instance if you collected your data in geomagnetic coordinates and then translated them to geographic coordinates you would set measurement_azimuth=0, translated_azimuth=-12.5 for a declination angle of N12.5E. angle of N12.5E.	0
translated_tilt Required: False Units: degrees Type: float Style: number Default: None	Tilt of channel in translated coordinate system, this should only be used for derived product. For instance if you collected your data using a tripod you would set measurement_tilt=45, translated_tilt=0 for a vertical component.	0
type Required: True Units: None Type: string Style: free form Default: none	Data type for the channel, should be a descriptive word that a user can understand.	temperature
units Required: True Units: None Type: string Style: controlled vocabulary Default: None	Units of the data, should be in SI units and represented as the full name of the unit all lowercase. If a complex unit use ‘per’ and ‘-‘.	celsius
data_quality.warnings Required: False Units: None Type: string Style: free form Default: None	any warnings about the data that should be noted	periodic pipeline noise
data_quality.good_from_period Required: False Units: None Type: float Style: number Default: None	Data are good for periods larger than this number	0.01
data_quality.good_to_period Required: False Units: None Type: float Style: number Default: None	Data are good for periods smaller than this number	1000
data_quality.flag Required: False Units: None Type: integer Style: number Default: None	Flag for data quality	0
data_quality.comments Required: False Units: None Type: string Style: free form Default: None	any comments about the data quality	0
data_quality.rating.author Required: False Units: None Type: string Style: free form Default: None	Author of who rated the data.	gradstudent ace
data_quality.rating.method Required: False Units: None Type: string Style: free form Default: None	The method used to rate the data.	standard deviation
data_quality.rating.value Required: True Units: None Type: integer Style: number Default: 0	A rating from 1-5 where 1 is bad and 5 is good and 0 if unrated.	4
filter.name Required: True Units: None Type: string Style: name list Default: []	Name of filter applied or to be applied. If more than one filter input as a comma separated list.	“[counts2mv, lo wpass_magnetic] “
filter.applied Required: True Units: None Type: boolean Style: name list Default: []	Boolean if filter has been applied or not. If more than one filter input as a comma separated list. Needs to be the same length as name or if only one entry is given it is assumed to apply to all filters listed.	“[True, False]”
filter.comments Required: False Units: None Type: string Style: name Default: None	Any comments on filters.	low pass is not calibrated
time_period.end Required: True Units: None Type: string Style: time Default: 1980-01-01T00:00:00+00:00	End date and time of collection in UTC.	2020-02-04T16:2 3:45.453670+00: 00
time_period.start Required: True Units: None Type: string Style: time Default: 1980-01-01T00:00:00+00:00	Start date and time of collection in UTC.	2020-02-01T09:2 3:45.453670+00: 00
sensor.id Required: True Units: None Type: string Style: free form Default: none	Instrument ID number can be serial number or a designated ID.	mt01
sensor.manufacturer Required: True Units: None Type: string Style: free form Default: none	Who manufactured the instrument.	mt gurus
sensor.type Required: True Units: None Type: string Style: free form Default: none	Description of the instrument type.	broadband 32-bit
sensor.model Required: False Units: None Type: string Style: free form Default: None	Model version of the instrument.	falcon5
sensor.name Required: False Units: None Type: string Style: free form Default: None	Standard marketing name of the instrument.	falcon5
fdsn.id Required: False Units: None Type: string Style: alpha numeric Default: None	Given FDSN archive ID name.	MT001
fdsn.network Required: False Units: None Type: string Style: alpha numeric Default: None	Given two character FDSN archive network code.	EM
fdsn.channel_code Required: False Units: None Type: string Style: alpha numeric Default: None	Three character FDSN channel code. http://docs.fdsn.org/projects/source- identifiers/en/v1.0/channel-codes.html	LQN
fdsn.new_epoch Required: False Units: None Type: boolean Style: name Default: None	Boolean telling if a new epoch needs to be created or not.	False
fdsn.alternate_code Required: False Units: None Type: string Style: free form Default: None	Alternate Code	_INT-NON_FDSN,. UNRESTRICTED,_U S-ALL,_US- MT,_US-MT-TA
fdsn.alternate_network_code Required: False Units: None Type: string Style: free form Default: None	Alternate Network Code	_INT-NON_FDSN,. UNRESTRICTED,_U S-ALL,_US- MT,_US-MT-TA
location.latitude Required: True Units: degrees Type: float Style: number Default: 0.0	latitude of location in datum specified at survey level	23.134
location.longitude Required: True Units: degrees Type: float Style: number Default: 0.0	longitude of location in datum specified at survey level	14.23
location.elevation Required: True Units: meters Type: float Style: number Default: 0.0	elevation of location in datum specified at survey level	123.4
location.x Required: False Units: meters Type: float Style: number Default: None	relative distance to the center of the station	10.0
location.y Required: False Units: meters Type: float Style: number Default: None	relative distance to the center of the station	10.0
location.z Required: False Units: meters Type: float Style: number Default: None	relative elevation to the center of the station	10.0

class mt_metadata.timeseries.Orientation(**kwargs)

Bases: Base

Metadata Key	Description	Example
method Required: True Units: None Type: string Style: controlled vocabulary Default: None	method for orienting station layout	compass
reference_frame Required: True Units: None Type: string Style: controlled vocabulary Default: geographic	“Reference frame for station layout. There are only 2 options geographic and geomagnetic. Both assume a right-handed coordinate system with North=0 E=90 and vertical positive downward”	geomagnetic
angle_to_geographic_north Required: False Units: degrees Type: float Style: number Default: None	“Angle to rotate the data to align with geographic north. If this number is 0 then it is assumed the data are aligned with geographic north in a right handed coordinate system.”	geomagnetic
value Required: False Units: None Type: string Style: controlled vocabulary Default: None	“Channel orientation relative to each other”	orthogonal

class mt_metadata.timeseries.Person(**kwargs)

Bases: Base

Metadata Key	Description	Example
name Required: True Units: None Type: string Style: free form Default: None	Persons name, should be full first and last name.	person name
author Required: False Units: None Type: string Style: free form Default: None	Persons name, should be full first and last name.	person name
organization Required: False Units: None Type: string Style: free form Default: None	Organization full name	mt gurus
email Required: False Units: None Type: string Style: email Default: None	Email of the contact person	mt.guru@em.org
url Required: False Units: None Type: string Style: free form Default: None	URL of the contact person	em.org
comments Required: False Units: None Type: string Style: email Default: None	Any comments about the person	expert digger

property author

class mt_metadata.timeseries.Provenance(**kwargs)

Bases: Base

Metadata Key	Description	Example
creation_time Required: True Units: None Type: string Style: date time Default: 1980-01-01T00:00:00+00:00	Date and time the file was created.	2020-02-08T12:2 3:40.324600+00: 00
comments Required: False Units: None Type: string Style: free form Default: None	Any comments on provenance of the data.	all good
log Required: False Units: None Type: string Style: free form Default: None	A history of changes made to the data.	2020-02-10T14:2 4:45+00:00 updated metadata
creator.name Required: True Units: None Type: string Style: free form Default: none	Persons name, should be full first and last name.	person name
creator.author Required: False Units: None Type: string Style: free form Default: None	Persons name, should be full first and last name.	person name
creator.organization Required: False Units: None Type: string Style: free form Default: None	Organization full name	mt gurus
creator.email Required: False Units: None Type: string Style: email Default: None	Email of the contact person	mt.guru@em.org
creator.url Required: False Units: None Type: string Style: free form Default: None	URL of the contact person	em.org
creator.comments Required: False Units: None Type: string Style: email Default: None	Any comments about the person	expert digger
submitter.name Required: True Units: None Type: string Style: free form Default: none	Persons name, should be full first and last name.	person name
submitter.author Required: False Units: None Type: string Style: free form Default: None	Persons name, should be full first and last name.	person name
submitter.organization Required: False Units: None Type: string Style: free form Default: None	Organization full name	mt gurus
submitter.email Required: False Units: None Type: string Style: email Default: None	Email of the contact person	mt.guru@em.org
submitter.url Required: False Units: None Type: string Style: free form Default: None	URL of the contact person	em.org
submitter.comments Required: False Units: None Type: string Style: email Default: None	Any comments about the person	expert digger
archive.name Required: True Units: None Type: string Style: free form Default: none	Persons name, should be full first and last name.	person name
archive.author Required: False Units: None Type: string Style: free form Default: None	Persons name, should be full first and last name.	person name
archive.organization Required: False Units: None Type: string Style: free form Default: None	Organization full name	mt gurus
archive.email Required: False Units: None Type: string Style: email Default: None	Email of the contact person	mt.guru@em.org
archive.url Required: False Units: None Type: string Style: free form Default: None	URL of the contact person	em.org
archive.comments Required: False Units: None Type: string Style: email Default: None	Any comments about the person	expert digger
software.author Required: True Units: None Type: string Style: free form Default: none	Author of the software	Neo
software.version Required: True Units: None Type: string Style: free form Default: none	Software version	12.01a
software.last_updated Required: False Units: None Type: string Style: date Default: 1980-01-01T00:00:00+00:00	Most recent date the software was updated. Prefer to use version, but this works for non-versioned software.	2020-01-01
software.name Required: True Units: None Type: string Style: free form Default: none	Software name	mtrules

property creation_time

class mt_metadata.timeseries.Rating(**kwargs)

Bases: Base

Metadata Key	Description	Example
author Required: False Units: None Type: string Style: free form Default: None	Author of who rated the data.	gradstudent ace
method Required: False Units: None Type: string Style: free form Default: None	The method used to rate the data.	standard deviation
value Required: True Units: None Type: integer Style: number Default: 0	A rating from 1-5 where 1 is bad and 5 is good and 0 if unrated.	4

class mt_metadata.timeseries.Run(**kwargs)

Bases: Base

Metadata Key	Description	Example
channels_recorded_auxiliary Required: True Units: None Type: string Style: name list Default: []	List of auxiliary channels recorded	[T]
channels_recorded_electric Required: True Units: None Type: string Style: name list Default: []	List of electric channels recorded	“[Ex , Ey]”
channels_recorded_magnetic Required: True Units: None Type: string Style: name list Default: []	List of magnetic channels recorded	“[Hx , Hy , Hz]”
comments Required: False Units: None Type: string Style: free form Default: None	Any comments on the run.	cows chewed cables
data_type Required: True Units: None Type: string Style: controlled vocabulary Default: BBMT	Type of data recorded for this run.	BBMT
id Required: True Units: None Type: string Style: alpha numeric Default: None	Run ID should be station name followed by a number or character. Characters should only be used if the run number is small, if the run number is high consider using digits with zeros. For example if you have 100 runs the run ID could be 001 or {station}001.	001
sample_rate Required: True Units: samples per second Type: float Style: number Default: 0.0	Digital sample rate for the run	100
fdsn.id Required: False Units: None Type: string Style: alpha numeric Default: None	Given FDSN archive ID name.	MT001
fdsn.network Required: False Units: None Type: string Style: alpha numeric Default: None	Given two character FDSN archive network code.	EM
fdsn.channel_code Required: False Units: None Type: string Style: alpha numeric Default: None	Three character FDSN channel code. http://docs.fdsn.org/projects/source- identifiers/en/v1.0/channel-codes.html	LQN
fdsn.new_epoch Required: False Units: None Type: boolean Style: name Default: None	Boolean telling if a new epoch needs to be created or not.	False
fdsn.alternate_code Required: False Units: None Type: string Style: free form Default: None	Alternate Code	_INT-NON_FDSN,. UNRESTRICTED,_U S-ALL,_US- MT,_US-MT-TA
fdsn.alternate_network_code Required: False Units: None Type: string Style: free form Default: None	Alternate Network Code	_INT-NON_FDSN,. UNRESTRICTED,_U S-ALL,_US- MT,_US-MT-TA
data_logger.id Required: True Units: None Type: string Style: free form Default: none	Instrument ID number can be serial number or a designated ID.	mt01
data_logger.manufacturer Required: True Units: None Type: string Style: free form Default: none	Who manufactured the instrument.	mt gurus
data_logger.type Required: True Units: None Type: string Style: free form Default: none	Description of the instrument type.	broadband 32-bit
data_logger.model Required: False Units: None Type: string Style: free form Default: None	Model version of the instrument.	falcon5
data_logger.name Required: False Units: None Type: string Style: free form Default: None	Standard marketing name of the instrument.	falcon5
data_logger.timing_system.comments Required: False Units: None Type: string Style: free form Default: None	Any comment on the timing system.	GPS locked with internal quartz clock
data_logger.timing_system.drift Required: True Units: seconds Type: float Style: number Default: 0.0	Estimated drift of the timing system.	0.001
data_logger.timing_system.type Required: True Units: None Type: string Style: free form Default: GPS	Type of timing system.	GPS
data_logger.timing_system.uncertainty Required: True Units: seconds Type: float Style: number Default: 0.0	Estimated uncertainty of the timing system.	0.0002
data_logger.timing_system.n_satellites Required: False Units: None Type: integer Style: number Default: None	Number of satellites used for timing.	6
data_logger.firmware.author Required: True Units: None Type: string Style: free form Default: None	Author of the software	Neo
data_logger.firmware.version Required: True Units: None Type: string Style: free form Default: None	Software version	12.01a
data_logger.firmware.last_updated Required: False Units: None Type: string Style: date Default: 1980-01-01T00:00:00+00:00	Most recent date the software was updated. Prefer to use version, but this works for non-versioned software.	2020-01-01
data_logger.firmware.name Required: True Units: None Type: string Style: free form Default: None	Software name	mtrules
data_logger.power_source.type Required: False Units: None Type: string Style: name Default: None	Description of battery type.	pb-acid gel cell
data_logger.power_source.id Required: False Units: None Type: string Style: name Default: None	battery id	battery01
data_logger.power_source.voltage.start Required: False Units: volts Type: float Style: number Default: None	Starting voltage	14.3
data_logger.power_source.voltage.end Required: False Units: volts Type: float Style: number Default: None	Ending voltage	12.1
data_logger.power_source.comments Required: False Units: None Type: string Style: name Default: None	Any comments about the battery.	discharged too quickly
time_period.end Required: True Units: None Type: string Style: time Default: 1980-01-01T00:00:00+00:00	End date and time of collection in UTC.	2020-02-04T16:2 3:45.453670+00: 00
time_period.start Required: True Units: None Type: string Style: time Default: 1980-01-01T00:00:00+00:00	Start date and time of collection in UTC.	2020-02-01T09:2 3:45.453670+00: 00
acquired_by.author Required: False Units: None Type: string Style: free form Default: None	Persons name, should be full first and last name.	person name
acquired_by.organization Required: False Units: None Type: string Style: free form Default: None	Organization full name	mt gurus
acquired_by.comments Required: False Units: None Type: string Style: email Default: None	Any comments about the person	expert digger
metadata_by.author Required: False Units: None Type: string Style: free form Default: None	Persons name, should be full first and last name.	person name
metadata_by.organization Required: False Units: None Type: string Style: free form Default: None	Organization full name	mt gurus
metadata_by.comments Required: False Units: None Type: string Style: email Default: None	Any comments about the person	expert digger
provenance.comments Required: False Units: None Type: string Style: free form Default: None	Any comments on provenance of the data.	all good
provenance.log Required: False Units: None Type: string Style: free form Default: None	A history of changes made to the data.	2020-02-10T14:2 4:45+00:00 updated metadata

add_channel(channel_obj, update=True)

Add a channel to the list, check if one exists if it does overwrite it

Parameters:

channel_obj (mt_metadata.timeseries.Channel) – channel object to add

channel_index(component)

get index of the channel in the channel list

property channels

List of channels in the run

property channels_recorded_all

a list of all channels recorded :rtype: TYPE

Type:

return

property channels_recorded_auxiliary

property channels_recorded_electric

property channels_recorded_magnetic

property ex

property ey

get_channel(component)

Get a channel

Parameters:

component (string) – channel component to look for

Returns:

channel object based on channel type

Return type:

mt_metadata.timeseries.Channel

has_channel(component)

Check to see if the channel already exists

Parameters:

component (string) – channel component to look for

Returns:

True if found, False if not

Return type:

boolean

property hx

property hy

property hz

property n_channels

remove_channel(channel_id)

remove a run from the survey

Parameters:

component (string) – channel component to look for

property temperature

update(other, match=[])

Update attribute values from another like element, skipping None

Parameters:

other (TYPE) – DESCRIPTION

Returns:

DESCRIPTION

Return type:

TYPE

update_time_period()

update time period from the channels

class mt_metadata.timeseries.Software(**kwargs)

Bases: Base

Metadata Key	Description	Example
author Required: True Units: None Type: string Style: free form Default: None	Author of the software	Neo
version Required: True Units: None Type: string Style: free form Default: None	Software version	12.01a
last_updated Required: False Units: None Type: string Style: date Default: 1980-01-01T00:00:00+00:00	Most recent date the software was updated. Prefer to use version, but this works for non-versioned software.	2020-01-01
name Required: True Units: None Type: string Style: free form Default: None	Software name	mtrules

property author

class mt_metadata.timeseries.Station(**kwargs)

Bases: Base

Metadata Key	Description	Example
channel_layout Required: False Units: None Type: string Style: controlled vocabulary Default: None	How the station channels were laid out.	x
channels_recorded Required: True Units: None Type: string Style: name list Default: []	List of components recorded by the station. Should be a summary of all channels recorded. Dropped channels will be recorded in Run metadata.	“[ Ex, Ey, Hx, Hy, Hz, T]”
comments Required: False Units: None Type: string Style: free form Default: None	Any comments on the station.	5 runs
data_type Required: True Units: None Type: string Style: controlled vocabulary Default: BBMT	Type of data recorded. If multiple types input as a comma separated list.	BBMT
geographic_name Required: True Units: None Type: string Style: free form Default: None	Closest geographic name to the station, usually a city, but could be another common geographic location.	“Whitehorse, YK”
id Required: True Units: None Type: string Style: alpha numeric Default: None	Station ID name. This should be an alpha numeric name that is typically 5-6 characters long. Commonly the project name in 2 or 3 letters and the station number.	MT001
run_list Required: True Units: None Type: string Style: name list Default: []	List of runs recorded by the station. Should be a summary of all runs recorded.	“[ mt001a, mt001b, mt001c ]”
fdsn.id Required: False Units: None Type: string Style: alpha numeric Default: None	Given FDSN archive ID name.	MT001
fdsn.network Required: False Units: None Type: string Style: alpha numeric Default: None	Given two character FDSN archive network code.	EM
fdsn.channel_code Required: False Units: None Type: string Style: alpha numeric Default: None	Three character FDSN channel code. http://docs.fdsn.org/projects/source- identifiers/en/v1.0/channel-codes.html	LQN
fdsn.new_epoch Required: False Units: None Type: boolean Style: name Default: None	Boolean telling if a new epoch needs to be created or not.	False
fdsn.alternate_code Required: False Units: None Type: string Style: free form Default: None	Alternate Code	_INT-NON_FDSN,. UNRESTRICTED,_U S-ALL,_US- MT,_US-MT-TA
fdsn.alternate_network_code Required: False Units: None Type: string Style: free form Default: None	Alternate Network Code	_INT-NON_FDSN,. UNRESTRICTED,_U S-ALL,_US- MT,_US-MT-TA
location.latitude Required: True Units: degrees Type: float Style: number Default: 0.0	latitude of location in datum specified at survey level	23.134
location.longitude Required: True Units: degrees Type: float Style: number Default: 0.0	longitude of location in datum specified at survey level	14.23
location.elevation Required: True Units: meters Type: float Style: number Default: 0.0	elevation of location in datum specified at survey level	123.4
location.latitude_uncertainty Required: False Units: degrees Type: float Style: number Default: None	uncertainty in latitude estimation in degrees	0.01
location.longitude_uncertainty Required: False Units: degrees Type: float Style: number Default: None	uncertainty in longitude estimation in degrees	0.01
location.elevation_uncertainty Required: False Units: meters Type: float Style: number Default: None	uncertainty in elevation estimation	0.01
location.datum Required: False Units: None Type: string Style: controlled vocabulary Default: None	Datum of the location values. Usually a well known datum like WGS84.	WGS84
location.x Required: False Units: meters Type: float Style: number Default: None	relative distance to the center of the station	10.0
location.x2 Required: False Units: meters Type: float Style: number Default: None	relative distance to the center of the station	10.0
location.y Required: False Units: meters Type: float Style: number Default: None	relative distance to the center of the station	10.0
location.y2 Required: False Units: meters Type: float Style: number Default: None	relative distance to the center of the station	10.0
location.z Required: False Units: meters Type: float Style: number Default: None	relative elevation to the center of the station	10.0
location.z2 Required: False Units: meters Type: float Style: number Default: None	relative elevation to the center of the station	10.0
location.x_uncertainty Required: False Units: meters Type: float Style: number Default: None	uncertainty in longitude estimation in x-direction	0.01
location.y_uncertainty Required: False Units: meters Type: float Style: number Default: None	uncertainty in longitude estimation in y-direction	0.01
location.z_uncertainty Required: False Units: meters Type: float Style: number Default: None	uncertainty in longitude estimation in z-direction	0.01
location.declination.comments Required: False Units: None Type: string Style: free form Default: None	any comments on declination	estimated from WMM 2016
location.declination.model Required: True Units: None Type: string Style: controlled vocabulary Default: WMM	geomagnetic reference model used to calculate declination	WMM
location.declination.epoch Required: False Units: None Type: string Style: free form Default: None	Epoch for which declination was approximated in.	2020
location.declination.value Required: True Units: degrees Type: float Style: number Default: 0.0	declination angle relative to geographic north positive clockwise	12.3
location.country Required: False Units: None Type: string Style: name list Default: None	Country of the geographic location, should be spelled out in full. Can be a list of countries.	United States of America
location.state Required: False Units: None Type: string Style: name list Default: None	State or province of the geographic location, should be spelled out in full. Can be a list of states or provinces.	[Colorado, Utah]
location.county Required: False Units: None Type: string Style: name list Default: None	County of the geographic location, should be spelled out in full. Can be a list of counties.	[Douglass, Fayet]
location.township Required: False Units: None Type: string Style: free form Default: None	Township or city name or code.	090
location.section Required: False Units: None Type: string Style: free form Default: None	Section name or code.	012
location.quarter Required: False Units: None Type: string Style: free form Default: None	Quarter section code.	400
location.parcel Required: False Units: None Type: string Style: free form Default: None	Land parcel ID.	46b29a
acquired_by.name Required: True Units: None Type: string Style: free form Default: none	Persons name, should be full first and last name.	person name
acquired_by.organization Required: False Units: None Type: string Style: free form Default: None	Organization full name	mt gurus
acquired_by.comments Required: False Units: None Type: string Style: email Default: None	Any comments about the person	expert digger
orientation.method Required: True Units: None Type: string Style: controlled vocabulary Default: None	method for orienting station layout	compass
orientation.reference_frame Required: True Units: None Type: string Style: controlled vocabulary Default: geographic	“Reference frame for station layout. There are only 2 options geographic and geomagnetic. Both assume a right-handed coordinate system with North=0 E=90 and vertical positive downward”	geomagnetic
orientation.angle_to_geographic_north Required: False Units: degrees Type: float Style: number Default: None	“Angle to rotate the data to align with geographic north. If this number is 0 then it is assumed the data are aligned with geographic north in a right handed coordinate system.”	geomagnetic
orientation.value Required: False Units: None Type: string Style: controlled vocabulary Default: None	“Channel orientation relative to each other”	orthogonal
provenance.creation_time Required: True Units: None Type: string Style: date time Default: 1980-01-01T00:00:00+00:00	Date and time the file was created.	2020-02-08T12:2 3:40.324600+00: 00
provenance.comments Required: False Units: None Type: string Style: free form Default: None	Any comments on provenance of the data.	all good
provenance.log Required: False Units: None Type: string Style: free form Default: None	A history of changes made to the data.	2020-02-10T14:2 4:45+00:00 updated metadata
provenance.creator.name Required: True Units: None Type: string Style: free form Default: None	Persons name, should be full first and last name.	person name
provenance.creator.author Required: False Units: None Type: string Style: free form Default: None	Persons name, should be full first and last name.	person name
provenance.creator.organization Required: False Units: None Type: string Style: free form Default: None	Organization full name	mt gurus
provenance.creator.email Required: False Units: None Type: string Style: email Default: None	Email of the contact person	mt.guru@em.org
provenance.creator.url Required: False Units: None Type: string Style: free form Default: None	URL of the contact person	em.org
provenance.creator.comments Required: False Units: None Type: string Style: email Default: None	Any comments about the person	expert digger
provenance.submitter.name Required: True Units: None Type: string Style: free form Default: None	Persons name, should be full first and last name.	person name
provenance.submitter.author Required: False Units: None Type: string Style: free form Default: None	Persons name, should be full first and last name.	person name
provenance.submitter.organization Required: True Units: None Type: string Style: free form Default: None	Organization full name	mt gurus
provenance.submitter.email Required: True Units: None Type: string Style: email Default: None	Email of the contact person	mt.guru@em.org
provenance.submitter.url Required: False Units: None Type: string Style: free form Default: None	URL of the contact person	em.org
provenance.submitter.comments Required: False Units: None Type: string Style: email Default: None	Any comments about the person	expert digger
provenance.archive.name Required: True Units: None Type: string Style: free form Default: None	Persons name, should be full first and last name.	person name
provenance.archive.author Required: False Units: None Type: string Style: free form Default: None	Persons name, should be full first and last name.	person name
provenance.archive.organization Required: False Units: None Type: string Style: free form Default: None	Organization full name	mt gurus
provenance.archive.email Required: False Units: None Type: string Style: email Default: None	Email of the contact person	mt.guru@em.org
provenance.archive.url Required: False Units: None Type: string Style: free form Default: None	URL of the contact person	em.org
provenance.archive.comments Required: False Units: None Type: string Style: email Default: None	Any comments about the person	expert digger
provenance.software.author Required: True Units: None Type: string Style: free form Default: None	Author of the software	Neo
provenance.software.version Required: True Units: None Type: string Style: free form Default: None	Software version	12.01a
provenance.software.last_updated Required: False Units: None Type: string Style: date Default: 1980-01-01T00:00:00+00:00	Most recent date the software was updated. Prefer to use version, but this works for non-versioned software.	2020-01-01
provenance.software.name Required: True Units: None Type: string Style: free form Default: None	Software name	mtrules
time_period.end Required: True Units: None Type: string Style: time Default: 1980-01-01T00:00:00+00:00	End date and time of collection in UTC.	2020-02-04T16:2 3:45.453670+00: 00
time_period.start Required: True Units: None Type: string Style: time Default: 1980-01-01T00:00:00+00:00	Start date and time of collection in UTC.	2020-02-01T09:2 3:45.453670+00: 00
release_license Required: False Units: None Type: string Style: controlled vocabulary Default: CC0-1.0	How the data can be used. The options are based on https://github.com/spdx/license- list-data	CC BY
doi Required: False Units: None Type: string Style: url Default: none	full url of the doi number	http://doi.###

add_run(run_obj, update=True)

Add a run, if one of the same name exists overwrite it.

Parameters:

run_obj (mt_metadata.timeseries.Run) – run object to add

property channels_recorded

A list of all channels recorded

Returns:

list of all unique channels recorded for the station

Return type:

list

get_run(run_id)

Get a mt_metadata.timeseries.Run object from the given id

Parameters:

run_id (string) – run id verbatim

has_run(run_id)

Check to see if the run id already exists

Parameters:

run_id (string) – run id verbatim

Returns:

Tru if exists, False if not

Return type:

boolean

remove_run(run_id, update=True)

remove a run from the survey

Parameters:

run_id (string) – run id verbatim

run_index(run_id)

Get the index of the run_id

Parameters:

run_id (string) – run id verbatim

Returns:

index of the run

Return type:

integer

property run_list

Return names of run in survey

property runs

Return run list

update_time_period()

update time period from run information

class mt_metadata.timeseries.Survey(**kwargs)

Bases: Base

Metadata Key	Description	Example
id Required: True Units: None Type: string Style: alpha numeric Default: None	Alpha numeric ID that will be unique for archiving.	EMT20
comments Required: False Units: None Type: string Style: free form Default: None	Any comments about the survey.	long survey
datum Required: True Units: None Type: string Style: controlled vocabulary Default: WGS84	Datum of latitude and longitude coordinates. Should be a well-known datum, such as WGS84, and will be the reference datum for all locations. This is important for the user, they need to make sure all coordinates in the survey and child items (i.e. stations, channels) are referenced to this datum.	WGS84
geographic_name Required: True Units: None Type: string Style: free form Default: None	Closest geographic reference to survey, usually a city but could be a landmark or some other common geographic reference point.	Yukon
name Required: True Units: None Type: string Style: free form Default: None	Descriptive name of the survey.	MT Characteriza tion of Yukon Terrane
project Required: True Units: None Type: string Style: free form Default: None	Alpha numeric name for the project e.g USGS- GEOMAG.	YUTOO
summary Required: True Units: None Type: string Style: free form Default: None	Summary paragraph of survey including the purpose; difficulties; data quality; summary of outcomes if the data have been processed and modeled.	long project of characterizing mineral resources in Yukon
time_period.end_date Required: True Units: None Type: string Style: date Default: 1980-01-01	End date of the survey in UTC.	1995-01-01
time_period.start_date Required: True Units: None Type: string Style: date Default: 1980-01-01	Start date of the survey in UTC.	1/2/2020
fdsn.id Required: False Units: None Type: string Style: alpha numeric Default: None	Given FDSN archive ID name.	MT001
fdsn.network Required: False Units: None Type: string Style: alpha numeric Default: None	Given two character FDSN archive network code.	EM
fdsn.channel_code Required: False Units: None Type: string Style: alpha numeric Default: None	Three character FDSN channel code. http://docs.fdsn.org/projects/source- identifiers/en/v1.0/channel-codes.html	LQN
fdsn.new_epoch Required: False Units: None Type: boolean Style: name Default: None	Boolean telling if a new epoch needs to be created or not.	False
fdsn.alternate_code Required: False Units: None Type: string Style: free form Default: None	Alternate Code	_INT-NON_FDSN,. UNRESTRICTED,_U S-ALL,_US- MT,_US-MT-TA
fdsn.alternate_network_code Required: False Units: None Type: string Style: free form Default: None	Alternate Network Code	_INT-NON_FDSN,. UNRESTRICTED,_U S-ALL,_US- MT,_US-MT-TA
acquired_by.author Required: False Units: None Type: string Style: free form Default: None	Persons name, should be full first and last name.	person name
acquired_by.organization Required: False Units: None Type: string Style: free form Default: None	Organization full name	mt gurus
acquired_by.comments Required: False Units: None Type: string Style: email Default: None	Any comments about the person	expert digger
funding_source.name Required: False Units: None Type: string Style: name list Default: None	Persons name, should be full first and last name.	person name
funding_source.organization Required: False Units: None Type: string Style: name list Default: None	Organization full name	mt gurus
funding_source.email Required: False Units: None Type: string Style: name list Default: None	Email of the contact person	mt.guru@em.org
funding_source.url Required: False Units: None Type: string Style: name list Default: None	URL of the contact person	em.org
funding_source.comments Required: False Units: None Type: string Style: free form Default: None	Any comments about the person	expert digger
funding_source.grant_id Required: False Units: None Type: string Style: name list Default: None	Grant ID number or name	MT-01-2020
citation_dataset.doi Required: True Units: None Type: string Style: url Default: none	full url of the doi number	http://doi.###
citation_dataset.authors Required: False Units: None Type: string Style: free form Default: None	author names	M.Tee A. Roura
citation_dataset.title Required: False Units: None Type: string Style: free form Default: None	Full title of the citation	Paper Title
citation_dataset.year Required: False Units: None Type: string Style: date Default: 1980-01-01T00:00:00+00:00	Year of citation	2020
citation_dataset.volume Required: False Units: None Type: string Style: free form Default: None	Journal volume of the citation	12
citation_dataset.pages Required: False Units: None Type: string Style: free form Default: None	Page numbers of the citation	10-15
citation_dataset.journal Required: False Units: None Type: string Style: free form Default: None	Journal title of citation	Journal of Geophysical Research
citation_journal.doi Required: True Units: None Type: string Style: url Default: none	full url of the doi number	http://doi.###
citation_journal.authors Required: False Units: None Type: string Style: free form Default: None	author names	M.Tee A. Roura
citation_journal.title Required: False Units: None Type: string Style: free form Default: None	Full title of the citation	Paper Title
citation_journal.year Required: False Units: None Type: string Style: date Default: 1980-01-01T00:00:00+00:00	Year of citation	2020
citation_journal.volume Required: False Units: None Type: string Style: free form Default: None	Journal volume of the citation	12
citation_journal.pages Required: False Units: None Type: string Style: free form Default: None	Page numbers of the citation	10-15
citation_journal.journal Required: False Units: None Type: string Style: free form Default: None	Journal title of citation	Journal of Geophysical Research
northwest_corner.latitude Required: True Units: degrees Type: float Style: number Default: 0.0	latitude of location in datum specified at survey level	23.134
northwest_corner.longitude Required: True Units: degrees Type: float Style: number Default: 0.0	longitude of location in datum specified at survey level	14.23
southeast_corner.latitude Required: True Units: degrees Type: float Style: number Default: 0.0	latitude of location in datum specified at survey level	23.134
southeast_corner.longitude Required: True Units: degrees Type: float Style: number Default: 0.0	longitude of location in datum specified at survey level	14.23
country Required: False Units: None Type: string Style: name list Default: None	Country of the geographic location, should be spelled out in full. Can be a list of countries.	United States of America
state Required: False Units: None Type: string Style: name list Default: None	State or province of the geographic location, should be spelled out in full. Can be a list of states or provinces.	[Colorado, Utah]
project_lead.author Required: False Units: None Type: string Style: free form Default: None	Persons name, should be full first and last name.	person name
project_lead.organization Required: True Units: None Type: string Style: free form Default: None	Organization full name	mt gurus
project_lead.email Required: True Units: None Type: string Style: email Default: None	Email of the contact person	mt.guru@em.org
release_license Required: True Units: None Type: string Style: controlled vocabulary Default: CC0-1.0	How the data can be used. The options are based on https://github.com/spdx/license- list-data	CC BY

add_station(station_obj, update=True)

Add a station, if has the same name update that object.

Parameters:

station_obj (:class:`mt_metadata.timeseries.Station) – station object to add

property filter_names

return a list of filter names

property filters

A dictionary of available filters

get_station(station_id)

Get a station from the station id

Parameters:

station_id (string) – station id verbatim

Returns:

station object

Return type:

mt_metadata.timeseries.Station

has_station(station_id)

Has station id

Parameters:

station_id (string) – station id verbatim

Returns:

True if exists or False if not

Return type:

boolean

remove_station(station_id, update=True)

remove a station from the survey

Parameters:

station_id (string) – station id verbatim

station_index(station_id)

Get station index

Parameters:

station_id (string) – station id verbatim

Returns:

index value if station is found

Return type:

integer

property station_names

Return names of station in survey

property stations

Return station list

update_bounding_box()

Update the bounding box of the survey from the station information

update_time_period()

Update the start and end time of the survey based on the stations

class mt_metadata.timeseries.TimePeriod(**kwargs)

Bases: Base

Metadata Key	Description	Example
end Required: True Units: None Type: string Style: time Default: 1980-01-01T00:00:00+00:00	End date and time of collection in UTC.	2020-02-04T16:2 3:45.453670+00: 00
start Required: True Units: None Type: string Style: time Default: 1980-01-01T00:00:00+00:00	Start date and time of collection in UTC.	2020-02-01T09:2 3:45.453670+00: 00

property end

property end_date

property start

property start_date

class mt_metadata.timeseries.TimingSystem(**kwargs)

Bases: Base

Metadata Key	Description	Example
comments Required: False Units: None Type: string Style: free form Default: None	Any comment on the timing system.	GPS locked with internal quartz clock
drift Required: True Units: seconds Type: float Style: number Default: 0.0	Estimated drift of the timing system.	0.001
type Required: True Units: None Type: string Style: free form Default: GPS	Type of timing system.	GPS
uncertainty Required: True Units: seconds Type: float Style: number Default: 0.0	Estimated uncertainty of the timing system.	0.0002
n_satellites Required: False Units: None Type: integer Style: number Default: None	Number of satellites used for timing.	6