SeisPy

Python modules for seismic data processing

Author: Xiaotao Yang (stcyang@gmail.com)

Introduction

This package is currently heavily dependent on obspy (www.obspy.org) to handle seismic data (download, read, and write, etc). Users are referred to obspy toolbox for related functions.

Available modules

This package is under active development. The currently available modules are listed here.

utils

This module contains frequently used utility functions not readily available in obspy.

obsmaster

This module contains functions to get and processing Ocean Bottom Seismometer (OBS) data. The functions and main processing modules for removing the tilt and compliance noises are inspired and modified from OBStools (https://github.com/nfsi-canada/OBStools) developed by Pascal Audet & Helen Janiszewski. The main tilt and compliance removal method is based on Janiszewski et al. (2019).

Installation

Create and activate the conda seispy environment

Make sure you have a working Anaconda installed. This step is required to have all dependencies installed for the package. You can also manually install the listed packages without creating the seispy environment OR if you already have these packages installed. The order of the following commands MATTERS.

$ conda create -n seispy -c conda-forge jupyter numpy scipy pandas python>=3.6 obspy mpi4py
$ conda activate seispy

The pandas and jupyter packages are currently not required, unless you plan to run the accompanied Jupyter notebooks in directory. mip4py is required to run parallel scripts stored in scripts directory. The modules have been fully tested on python 3.7.x but versions >= 3.6 also seem to work from a few tests.

Download seispy

cd to the directory you want to save the package files. Then,

$ git clone https://github.com/xtyangpsp/SeisPy.git

Install seispy package functions using pip

This step will install the SeisPy modules under seispy environment. The modules would then be imported under any working directory. Remember to rerun this command if you modified the functions/modules.

$ pip install .

Test the installation

Run the following commands to test your installation.

$ python
>>> from seispy import obsmaster as obs
>>> tflist=obs.gettflist(help=True)
------------------------------------------------------------------
| Key    | Default  | Note                                       |
------------------------------------------------------------------
| ZP     | True     | Vertical and pressure                      |
| Z1     | True     | Vertical and horizontal-1                  |
| Z2-1   | True     | Vertical and horizontals (1 and 2)         |
| ZP-21  | True     | Vertical, pressure, and two horizontals    |
| ZH     | True     | Vertical and rotated horizontal            |
| ZP-H   | True     | Vertical, pressure, and rotated horizontal |
------------------------------------------------------------------

Structure of the package

seispy: This directory contains the main modules.
notebooks: This directory contains the jupyter notebooks that provide tutorials for all modules.
data: Data for testing or running the tutorials is saved under this folder.
figs: Here we put figures in tutorials and other places.
scripts: This directory contains example scripts for data processing using seispy. Users are welcome to modify from the provided example scripts to work on their own data.

Tutorials

To-be-added.

Contribute

Any bugs and ideas are welcome. Please contact me.

References

Bell, S. W., D. W. Forsyth, & Y. Ruan (2015), Removing Noise from the Vertical Component Records of Ocean-Bottom Seismometers: Results from Year One of the Cascadia Initiative, Bull. Seismol. Soc. Am., 105(1), 300-313, doi:10.1785/0120140054.
Janiszewski, H A, J B Gaherty, G A Abers, H Gao, Z C Eilon, Amphibious surface-wave phase-velocity measurements of the Cascadia subduction zone, Geophysical Journal International, Volume 217, Issue 3, June 2019, Pages 1929-1948, https://doi.org/10.1093/gji/ggz051
Tian, Y., & M. H. Ritzwoller (2017), Improving ambient noise cross-correlations in the noisy ocean bottom environment of the Juan de Fuca plate, Geophys. J. Int., 210(3), 1787-1805, doi:10.1093/gji/ggx281.

aisanxi/SeisPy