MSNoise - Documentation
Originally, MSNoise was a “Python Package for Monitoring Seismic Velocity Changes using Ambient Seismic Noise”. With the release of MSNoise 1.4, and because of the Plugin Support, we could call MSNoise: “Measuring with Seismic Noise”.
The current release version of MSNoise is MSNoise 2.0 and is a Python 3 version only.
The standard MSNoise workflow is designed to go from seismic data archives to dv/v curves. The monitoring is achieved by computing the cross-correlation of continuous seismic records for each pair of a network and by studying the changes in the cross-correlation function relative to a reference.
The goal of the “suite” is to provide researchers with an efficient processing tool, while keeping the need for coding to a minimum and avoiding being a black box. Moreover, as long as the in- and outputs of each step are respected, they can easily be replaced with one’s own codes ! (See Project Initialization).
Plugins can be added and extend the standard workflow from any steps, e.g. using MSNoise as a cross-correlation toolbox until the stack step, and then branching to the workflow provided by one’s plugin.
If you use MSNoise for your research and prepare publications, please consider citing MSNoise: Lecocq, T., C. Caudron, et F. Brenguier (2014), MSNoise, a Python Package for Monitoring Seismic Velocity Changes Using Ambient Seismic Noise, Seismological Research Letters, 85(3), 715‑726, doi:10.1785/0220130073.
Installation
Workflows:
Initializing and Configuring a Project
Commands in this workflow have the msnoise <command> form.
Cross-Correlation Functions
Commands in this workflow have the msnoise cc <command> form.
Computing Relative Velocity Variations
Commands in this workflow have the msnoise cc dvv <command> form.
Computing Power Spectral Densities (Quality Control)
Commands in this workflow have the msnoise qc <command> form.
Interacting with MSNoise
- How To’s - Recipes
- Run MSNoise only to have Power Spectral Densities and Spectrograms:
- Run the simplest MSNoise run ever
- Run MSNoise using lots of cores on a HPC
- Reprocess data
- Define one’s own data structure of the waveform archive
- How to have MSNoise work with 2+ data structures at the same time
- How to duplicate/dump the MSNoise configuration
- Check if my response file works
- Testing the Dependencies
- Interaction Examples & Gallery
- MSNoise API
get_logger()get_engine()connect()create_database_inifile()read_db_inifile()get_config()update_config()get_params()get_filters()update_filter()get_networks()get_stations()get_station()update_station()get_station_pairs()check_stations_uniqueness()get_interstation_distance()update_data_availability()get_new_files()get_data_availability()mark_data_availability()count_data_availability_flags()update_job()massive_insert_job()massive_update_job()is_next_job()get_next_job()get_dvv_jobs()is_dtt_next_job()get_dtt_next_job()reset_jobs()reset_dtt_jobs()get_job_types()get_jobs_by_lastmod()export_allcorr()export_allcorr2()add_corr()export_sac()export_mseed()stack()get_extension()get_ref()get_results()get_mwcs()get_results_all()get_maxlag_samples()get_t_axis()get_components_to_compute()get_components_to_compute_single_station()build_ref_datelist()build_movstack_datelist()updated_days_for_dates()azimuth()nextpow2()check_and_phase_shift()getGaps()make_same_length()preload_instrument_responses()to_sds()psd_read_results()psd_ppsd_to_dataframe()hdf_open_store_from_fn()hdf_open_store()hdf_insert_or_update()hdf_close_store()xr_create_or_open()xr_insert_or_update()xr_save_and_close()get_dvv()xr_save_ccf()xr_get_ccf()xr_save_ref()xr_get_ref()xr_save_mwcs()xr_get_mwcs()xr_save_dtt()xr_get_dtt()xr_save_dvv()xr_get_dvv()wavg()wstd()get_wavgwstd()trim()compute_dvv()xr_save_wct()
- Core Functions
- Extending MSNoise with Plugins