Metadata-Version: 2.1
Name: yews
Version: 0.0.4
Summary: Deep Learning toolbox for seismic waveform processing.
Home-page: https://github.com/lijunzh/yews
Author: Lijun Zhu
Author-email: gatechzhu@gmail.com
License: Apache 2.0
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
        ============
        
        It is recommened to first install `PyTorch <https://github.com/pytorch/pytorch>`_ using the offical guide: https://pytorch.org/get-started/locally/ . Then, install `Yews <https://github.com/lijunzh/yews>`_ via one of the following approaches:
        
        conda:
        
        .. code:: bash
        
           conda install -c lijunzhu -c pytorch yews
        
        
        pip:
        
        .. code:: bash
        
           pip install yews
        
        
        From source:
        
        .. code:: bash
        
            python setup.py install
        
        
        Note:
        
        1. These assume that you have PyTorch installed via the default method.
        
        2. If, however, yews is installed without going through the official PyTorch installation, it will still be installed properly using the pip method
        
        3. The lateset PyTorch 1.0.1 has been manually uploaded to lijunzhu channel on anaconda cloud, which makes it possible to install PyTorch automatically as a dependency using the conda method. However, it does not support older PyTorch versions for now. Future updates of PyTorch will be added ASAP.
        
        4. Yews can be installed via *conda-forge* with all dependencies handled automatically; however, it only supports the **CPU** version as *PyTorch* does not have a **GPU** version for the conda-forge channel.
        
        
        
        Documentation
        =============
        
        You can find the API documentation on the yews website: https://www.yews.info
        
        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.
        
        
Platform: any
Classifier: Development Status :: 2 - Pre-Alpha
Classifier: Topic :: Scientific/Engineering
Classifier: Topic :: Scientific/Engineering :: Artificial Intelligence
Classifier: Topic :: Scientific/Engineering :: Physics
Classifier: Programming Language :: Python
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3 :: Only
Classifier: Programming Language :: Python :: 3.6
Classifier: Programming Language :: Python :: 3.7
Classifier: Environment :: Console
Classifier: Intended Audience :: Developers
Classifier: Intended Audience :: Science/Research
Classifier: License :: OSI Approved :: Apache Software License
Classifier: Operating System :: POSIX :: Linux
Classifier: Operating System :: Unix
Classifier: Operating System :: MacOS
Classifier: Operating System :: Microsoft :: Windows
Requires-Python: >=3.6
Description-Content-Type: text/x-rst
Provides-Extra: testing
Provides-Extra: all
