<commit_before># Ricker Wavelet Generator

[![Build Status](https://travis-ci.org/gatechzhu/ricker.svg?branch=master)](https://travis-ci.org/gatechzhu/ricker)

## Introduction
[Ricker wavelet](http://wiki.seg.org/wiki/Dictionary:Ricker_wavelet) (Mexican hat signal) is widely used in synthetic seismic simulation. Although, [SciPy](https://github.com/scipy/scipy#id1) offers a nice [ricker](https://docs.scipy.org/doc/scipy-0.18.1/reference/generated/scipy.signal.ricker.html) generator, it is very basic and limited in flexibility. After repeated writing similar code to generate a shifted Ricker wavelet, I decided to write a small tool for it.  

## Dependancy
- [NumPy](http://www.numpy.org/)

## Installation
The main program should run under py26, py27, py33, py34; however, I only 
support py34 and up due to syntax conventions (mainly function annotation). 
Anyone can fork this repo and do some modification so that it will work 
perfectly fine in py33 and below.

### From source file
Under the root directory, type:

```
python setup.py install
```
<commit_msg>Update README.md for PyPI support<commit_after># Ricker Wavelet Generator

[![PyPI version](https://badge.fury.io/py/ricker.svg)](https://badge.fury.io/py/ricker) 
[![Build Status](https://travis-ci.org/gatechzhu/ricker.svg?branch=master)](https://travis-ci.org/gatechzhu/ricker)

## Introduction
[Ricker wavelet](http://wiki.seg.org/wiki/Dictionary:Ricker_wavelet) (Mexican hat signal) is widely used in synthetic seismic simulation. Although, [SciPy](https://github.com/scipy/scipy#id1) offers a nice [ricker](https://docs.scipy.org/doc/scipy-0.18.1/reference/generated/scipy.signal.ricker.html) generator, it is very basic and limited in flexibility. After repeated writing similar code to generate a shifted Ricker wavelet, I decided to write a small tool for it.  

## Dependancy
- [NumPy](http://www.numpy.org/)

## Installation
The main program should run under py26, py27, py33, py34; however, I only 
support py34 and up due to syntax conventions (mainly function annotation). 
Anyone can fork this repo and do some modification so that it will work 
perfectly fine in py33 and below.

### From PyPI
```
pip install ricker
```

### From source file
Download srouce file from [releases page](https://github.com/gatechzhu/ricker/releases). Under the root directory, type:

```
python setup.py install
```

## Contact

{'fraction_non_alphanumeric': 0.11936560934891485, 'fraction_numerical': 0.014190317195325543, 'mean_word_length': 4.860635696821516, 'pattern_counts': {'":': 0, '<': 3, '<?xml version=': 0, '>': 3, 'https://': 11, 'lorem ipsum': 0, 'www.': 2, 'xml': 0}, 'pii_count': 0, 'substrings_counts': 0, 'word_list_counts': {'cursed_substrings.json': 1, 'profanity_word_list.json': 0, 'sexual_word_list.json': 0, 'zh_pornsignals.json': 0}}
{'dir': 'git-commits-cleaned', 'id': '7671161', 'n_tokens_mistral': 794, 'n_tokens_neox': 751, 'n_words': 242}