README.md 2.3 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
![GitHub tag (latest by date)](https://img.shields.io/github/v/tag/xumi1993/seispy)
Mijian Xu's avatar
Mijian Xu 已提交
7
[![](https://img.shields.io/github/last-commit/xumi1993/seispy)]()
Mijian Xu's avatar
readme    
Mijian Xu 已提交
8
[![](https://img.shields.io/github/commit-activity/m/xumi1993/seispy)]()
Mijian Xu's avatar
Mijian Xu 已提交
9
10
![GitHub code size in bytes](https://img.shields.io/github/languages/code-size/xumi1993/seispy)
![GitHub repo size](https://img.shields.io/github/repo-size/xumi1993/seispy)
Mijian Xu's avatar
Mijian Xu 已提交
11
[![](https://img.shields.io/github/forks/xumi1993/seispy?style=social)]()
Mijian Xu's avatar
Mijian Xu 已提交
12

Mijian Xu's avatar
Mijian Xu 已提交
13
14
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 已提交
15

Mijian Xu's avatar
Mijian Xu 已提交
16
17
# Installation
## Dependencies
Mijian Xu's avatar
Mijian Xu 已提交
18
19
  * [Python]() >= 3.6
  * [ObsPy](http://docs.obspy.org) >= 1.1.0
Mijian Xu's avatar
Mijian Xu 已提交
20
  * [NumPy](http://www.numpy.org/) >= 1.16
Mijian Xu's avatar
Mijian Xu 已提交
21
22
23
  * [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 已提交
24
  
Mijian Xu's avatar
Mijian Xu 已提交
25
## Installation
Mijian Xu's avatar
Mijian Xu 已提交
26
27
```
git clone https://github.com/xumi1993/seispy.git
Mijian Xu's avatar
Mijian Xu 已提交
28
python setup.py install
Mijian Xu's avatar
Mijian Xu 已提交
29
```
Mijian Xu's avatar
Mijian Xu 已提交
30

Mijian Xu's avatar
Mijian Xu 已提交
31
# Inclusion
Mijian Xu's avatar
Mijian Xu 已提交
32
33
34
35
## 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 已提交
36
  * `seispy.decov`: Iterative time domain deconvolution method (Ligorria and Ammon's 1999 BSSA)
Mijian Xu's avatar
Mijian Xu 已提交
37
38
39
  * `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 已提交
40
41

## Commands
Mijian Xu's avatar
Mijian Xu 已提交
42
 * `prf`: Calculate PRFs for a station.
Mijian Xu's avatar
Mijian Xu 已提交
43
 * `pickrf`: Reject PRFs with poor qualities after the calculation.
Mijian Xu's avatar
Mijian Xu 已提交
44
45
46
47
 * `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 已提交
48
 * `ccp_profile`: Stack PRFs along a profile with a CCP stacking method.
Mijian Xu's avatar
Mijian Xu 已提交
49