Skip to content
Yews | Your Earthquake Waveform Solution
Python Makefile
Branch: master
Clone or download
Fetching latest commit…
Cannot retrieve the latest commit at this time.
Permalink
Type Name Latest commit message Commit time
Failed to load latest commit information.
anaconda
examples
src/yews
tests
.coveragerc
.gitignore
.pre-commit-config.yaml
.travis.yml
CHANGELOG.rst
LICENSE
MANIFEST.in
Makefile
README.rst
appveyor.yml
hubconf.py
setup.cfg
setup.py
torch_rbp_install.rst

README.rst

Yews Logo


Yews is a deep learning toolbox for processing seismic waveform made with flexibility, speed, and usability in mind. It is built upon PyTorch for researchers interested in applying deep learning techniques on seismic waveform data.

https://travis-ci.com/lijunzh/yews.svg?branch=master https://ci.appveyor.com/api/projects/status/32r7s2skrgm9ubva?svg=true https://pepy.tech/badge/yews

Installation

To ensure the GPU-powered PyTorch , first isntall PyTorch using the offical guide: https://pytorch.org/get-started/locally/ and then install Yews via one of the following approaches:

conda:

conda install -c lijunzhu -c pytorch yews

conda-forge:

conda install -c conda-forge yews

pip:

pip install yews

From source:

python setup.py install

Note:

  1. Running the above command without first installing PyTorch may still work. Depending on the OS, you may get either the GPU or CPU version of PyTorch. For example, MacOS currently will get the CPU Pytorch while Linux will get the GPU PyTorch by default. Please refer to https://pytorch.org/get-started/locally/ for details.

  2. yews by itself is noarch, which means it is pure Python and OS independent. Most inconsistenciews between OS's are primarily due to the upstream difference (e.g. PyTorch and NumPy).

  3. obspy is an optional dependency, which is used for seismic waveform I/O; however, yews's core functionalities do not depend on obspy.

  4. You can install all yews optional dependencies via pip install yews[all].

  5. Below are the instructions to each optional dependencies to install them separately in conda.

    Dependency

    Instructions

    obspy

    conda install -c conda-forge obspy

    scipy

    conda install scipy

    tqdm

    conda install tqdm

Documentation

You can find the API documentation on the yews website: https://www.yews.info/docs/

Contributing

We appreciate all contributions. If you are planning to contribute back bug-fixes, please do so without any further discussion. If you plan to contribute new features, utility functions or extensions, please first open an issue and discuss the feature with us.

You can’t perform that action at this time.