README.md 2.1 KB
Newer Older
Mijian Xu's avatar
Mijian Xu 已提交
1
# Seispy
Mijian Xu's avatar
Mijian Xu 已提交
2

Mijian Xu's avatar
Mijian Xu 已提交
3
[![pipeline status](https://img.shields.io/travis/com/xumi1993/seispy)](https://travis-ci.com/xumi1993/seispy)
Mijian Xu's avatar
Mijian Xu 已提交
4
[![Build Status](https://img.shields.io/travis/com/xumi1993/seispy-doc.post?label=doc)](https://travis-ci.com/xumi1993/seispy-doc.post)
Mijian Xu's avatar
Mijian Xu 已提交
5
[![GitHub](https://img.shields.io/github/license/xumi1993/seispy)]()
Mijian Xu's avatar
Mijian Xu 已提交
6
[![](https://img.shields.io/github/last-commit/xumi1993/seispy)]()
Mijian Xu's avatar
readme    
Mijian Xu 已提交
7
[![](https://img.shields.io/github/commit-activity/m/xumi1993/seispy)]()
Mijian Xu's avatar
Mijian Xu 已提交
8
[![](https://img.shields.io/github/forks/xumi1993/seispy?style=social)]()
Mijian Xu's avatar
Mijian Xu 已提交
9

Mijian Xu's avatar
Mijian Xu 已提交
10
11
Seispy is a Python module for processing seismological data and calculating Receiver Functions. The advanced functions are available to improve the Obspy.

Mijian Xu's avatar
Mijian Xu 已提交
12

Mijian Xu's avatar
Mijian Xu 已提交
13
14
# Installation
## Dependencies
Mijian Xu's avatar
Mijian Xu 已提交
15
16
  * [Python]() >= 3.6
  * [ObsPy](http://docs.obspy.org) >= 1.1.0
Mijian Xu's avatar
Mijian Xu 已提交
17
  * [NumPy](http://www.numpy.org/) >= 1.16
Mijian Xu's avatar
Mijian Xu 已提交
18
19
20
  * [SciPy](http://www.scipy.org/) >= 1.2.0
  * [matplotlib](https://matplotlib.org/) >= 3.0.0
  * [PyQt5](https://www.riverbankcomputing.com/software/pyqt/)
Mijian Xu's avatar
Mijian Xu 已提交
21
  
Mijian Xu's avatar
Mijian Xu 已提交
22
## Installation
Mijian Xu's avatar
Mijian Xu 已提交
23
24
```
git clone https://github.com/xumi1993/seispy.git
Mijian Xu's avatar
Mijian Xu 已提交
25
python setup.py install
Mijian Xu's avatar
Mijian Xu 已提交
26
```
Mijian Xu's avatar
Mijian Xu 已提交
27

Mijian Xu's avatar
Mijian Xu 已提交
28
# Inclusion
Mijian Xu's avatar
Mijian Xu 已提交
29
30
31
32
## Libraries
  * `seispy.distaz`: Calculate distance and azimuth (by [the lithospheric seismology program at USC](http://www.seis.sc.edu/software/distaz/)).<br />
  * `seispy.geo`: Tiny codes of geophysics.
  * `seispy.bootstrap`: Bootstrap confidence interval estimation (by [scikits-bootstrap](https://github.com/cgevans/scikits-bootstrap))
Mijian Xu's avatar
Mijian Xu 已提交
33
  * `seispy.decov`: Iterative time domain deconvolution method (Ligorria and Ammon's 1999 BSSA)
Mijian Xu's avatar
Mijian Xu 已提交
34
35
36
  * `seispy.rfcorrect`: Subsequent process of PRFs includeing moveout correct and time to depth conversion (1D and 3D) (see Mijian Xu et al., 2018 EPSL)
  * `seispy.ccp`: CCP stacking along a profile.

Mijian Xu's avatar
Mijian Xu 已提交
37
38

## Commands
Mijian Xu's avatar
Mijian Xu 已提交
39
 * `prf`: Calculate PRFs for a station.
Mijian Xu's avatar
Mijian Xu 已提交
40
 * `pickrf`: Reject PRFs with poor qualities after the calculation.
Mijian Xu's avatar
Mijian Xu 已提交
41
42
43
44
 * `plotrt`: Plot PRFs in R and T components order by back-azimuth.
 * `plotr`: Plot PRFs in R component order by back-azimuth.
 * `hk`: H-Kappa stacking.
 * `rf2depth`: Convert PRFs to depth axis.
Mijian Xu's avatar
Mijian Xu 已提交
45
 * `ccp_profile`: Stack PRFs along a profile with a CCP stacking method.
Mijian Xu's avatar
Mijian Xu 已提交
46