Skip to main content

Deep Learning toolbox for seismic waveform processing.

Project description

.. image:: https://raw.githubusercontent.com/lijunzh/yews-docs/master/source/_static/img/logo/yews_logo.gif
:scale: 50 %
:alt: Yews Logo
:align: center


========================================



Yews is a deep learning toolbox for processing seismic waveform made with
flexibility, speed, and usability in mind. It is built upon
`PyTorch <https://github.com/pytorch/pytorch>`_ for researchers interested in
applying deep learning techniques on seismic waveform data.




.. image:: https://travis-ci.com/lijunzh/yews.svg?branch=master
:target: https://travis-ci.com/lijunzh/yews

.. image:: https://ci.appveyor.com/api/projects/status/32r7s2skrgm9ubva?svg=true
:target: https://ci.appveyor.com/project/lijunzh/yews

.. image:: https://codecov.io/gh/lijunzh/yews/branch/master/graph/badge.svg
:target: https://codecov.io/gh/lijunzh/yews

.. image:: https://anaconda.org/lijunzhu/yews/badges/version.svg
:target: https://anaconda.org/lijunzhu/yews

.. image:: https://badge.fury.io/py/yews.svg
:target: https://badge.fury.io/py/yews

.. image:: https://pepy.tech/badge/yews
:target: https://pepy.tech/project/yews

Installation
============

To ensure the GPU-powered `PyTorch <https://github.com/pytorch/pytorch>`_ ,
first isntall PyTorch using the offical guide:
https://pytorch.org/get-started/locally/ and then install
`Yews <https://github.com/lijunzh/yews>`_ via one of the following approaches:

conda:

.. code:: bash

conda install -c lijunzhu -c pytorch yews

conda-forge:

.. code:: bash

conda install -c conda-forge yews


pip:

.. code:: bash

pip install yews


From source:

.. code:: bash

python setup.py install


Note:

#. 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.

#. ``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).

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

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

#. 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.


Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

yews-0.0.6.tar.gz (92.1 kB view details)

Uploaded Source

Built Distribution

yews-0.0.6-py2.py3-none-any.whl (26.7 kB view details)

Uploaded Python 2 Python 3

File details

Details for the file yews-0.0.6.tar.gz.

File metadata

  • Download URL: yews-0.0.6.tar.gz
  • Upload date:
  • Size: 92.1 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/1.13.0 pkginfo/1.5.0.1 requests/2.22.0 setuptools/41.6.0.post20191030 requests-toolbelt/0.9.1 tqdm/4.36.1 CPython/3.7.5

File hashes

Hashes for yews-0.0.6.tar.gz
Algorithm Hash digest
SHA256 4f262651634fbc847e12b47077a108727f79c50ea2d1b665b1ba7ac5c91e6abd
MD5 bef6e226c067adc419de217d54987c3a
BLAKE2b-256 26c19397bbe843c4e307dcc652f32b82bafa96be771b7501742d0ff0c122b45a

See more details on using hashes here.

File details

Details for the file yews-0.0.6-py2.py3-none-any.whl.

File metadata

  • Download URL: yews-0.0.6-py2.py3-none-any.whl
  • Upload date:
  • Size: 26.7 kB
  • Tags: Python 2, Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/1.13.0 pkginfo/1.5.0.1 requests/2.22.0 setuptools/41.6.0.post20191030 requests-toolbelt/0.9.1 tqdm/4.36.1 CPython/3.7.5

File hashes

Hashes for yews-0.0.6-py2.py3-none-any.whl
Algorithm Hash digest
SHA256 3e05433d5c051175a9171d9b556142ee25952f9bee08dea843ecc8765fdd5246
MD5 4cdfc8125f86764c5d52610a3d4bf253
BLAKE2b-256 5c937dd9aff1911bcadda585c2ab233f39db832a15480bda7b5e26536731c38b

See more details on using hashes here.

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page