Metadata-Version: 2.1
Name: bpptkg-richter
Version: 0.4.0
Summary: Python library for computing Richter local magnitude scales on BPPTKG seismic network
Home-page: https://gitlab.com/bpptkg/bpptkg-richter
Author: Indra Rudianto
Author-email: indrarudianto.official@gmail.com
License: MIT
Description: # bpptkg-richter
        
        Python library for computing Richter local magnitude scales on BPPTKG seismic
        network.
        
        ## Requirements
        
        * Python 3.5+
        * numpy
        * python-dateutil
        
        ## Installation
        
        **bpptkg-richter** is available on PyPI, you can install it by typing this
        command:
        
            pip install -U bpptkg-richter
        
        ## Richter Magnitude Scales
        
        This package also provides a method for computing Richter local magnitude scales
        on BPPTKG seismic network (`VG`). Currently supported stations are `MEDEL`,
        `MELAB`, `MEPAS`, `MEPUS` and only support `Z` component.
        
        You may want to install [ObsPy](https://www.obspy.org/) package, because
        this package only work on ObsPy stream type. Default network is `VG` and
        default component is `Z`:
        
        ```python
        from obspy import read
        import richter
        
        stream = read('/path/to/stream.mseed')
        
        # Compute Richter local magnitude for station MEPAS
        ml = richter.compute_ml(stream, 'MEPAS', network='VG', component='Z')
        
        # Compute Wood-Anderson zero-to-peak amplitude in meter for station MEPAS
        wa_ampl = richter.compute_wa(stream, 'MEPAS', network='VG', component='Z')
        
        # Compute count amplitude peak-to-peak for station MEPAS
        app = richter.compute_app(stream, 'MEPAS', network='VG', component='Z')
        ```
        
        or for short:
        
        ```python
        from obspy import read
        import richter
        
        stream = read('/path/to/stream.mseed')
        
        ml = richter.compute_ml(stream, 'MEPAS')
        wa_ampl = richter.compute_wa(stream, 'MEPAS')
        app = richter.compute_app(stream, 'MEPAS')
        ```
        
        For current version, on computing local magnitude (`compute_ml`) and
        Wood-Anderson amplitude(`compute_wa`), the only supported component is `Z`
        component.
        
        `compute_app` support other components, for example:
        
        ```python
        app = richter.compute_app(stream, 'MELAB', component='E')
        ```
        
        ## Documentation
        
        Full documentation and guides are available at `docs/` directory. You can build
        the documentation by running these commands:
        
            cd /path/to/bpptkg-richter/
            pip install -r requirements.txt
            sphinx-build -b html docs/ /path/to/build/
        
        ## Support
        
        This project is maintained by Indra Rudianto. If you have any question about
        this project, you can contact him at <indrarudianto.official@gmail.com>.
        
        ## License
        
        By contributing to the project, you agree that your contributions will be
        licensed under its MIT license. See
        [LICENSE](https://gitlab.com/bpptkg/bpptkg-richter/blob/master/LICENSE) for
        details.
        
Platform: UNKNOWN
Classifier: Development Status :: 5 - Production/Stable
Classifier: Environment :: Console
Classifier: Operating System :: POSIX :: Linux
Classifier: Intended Audience :: Science/Research
Classifier: Natural Language :: English
Classifier: Programming Language :: Python :: 3.5
Classifier: Programming Language :: Python :: 3.6
Classifier: Programming Language :: Python :: 3.7
Description-Content-Type: text/markdown
