Metadata-Version: 2.1
Name: quakeio
Version: 0.0.4
Summary: quakeio
Home-page: https://github.com/claudioperez/quakeio
Author: Claudio M. Perez
Author-email: claudio_perez@berkeley.edu
License: UNKNOWN
Description: # quake-io
        
        [![PyPI Downloads][pypi-v-image]][pypi-v-link]
        [![PyPI Version][pypi-d-image]][pypi-d-link]
        ![][cov-img]
        <!-- ![Build][build-img] -->
        [![Commits since latest release][gh-image]][gh-link]
        
        QuakeIO is a library of utilities for parsing ground motion files. Interfaces are provided for Python, Matlab, and the command line.
        
        ## Formats
        
        | Format          | Read      | Write   |  Reference      |
        |-----------------|-----------|---------|-------------------------|
        |`[quakeio.]json` | &#9745;   | &#9745; | [schema][record-schema] |
        |`csmip`          | &#9744;   | &#9744; |                         |
        |`csmip.v2`       | &#9745;   | &#9744; | [CSMIP][CSMIP]          |
        |`eqsig`          | &#9745;   | &#9745; | [eqsig][EQSIG]          |
        |`PEER.NGA`       | &#9745;   | &#9744; |                         |
        |`plain.tsv`      | &#9744;   | &#9744; |                         |
        |`opensees`       | &#9744;   | &#9744; |                         |
        |`plain.csv`      | &#9744;   | &#9744; |                         |
        |`mdof`           | &#9744;   | &#9744; |                         |
        | SimCenter.Event | &#9744;   | &#9744; |                         |
        
        ## Examples
        
        ### Command line
        
        ```bash
        $ quakeio -a rot:30 chan001.v2 -t html
        ```
        
        Rotate and calculate Husid series.
        ```bash
        $ quakeio -c 'rot:30;husid;' chan001.v2 
        ```
        
        ```bash
        $ cat chan001.v2 | quakeio -a rot:30 -f csmip.v2 -t html | pandoc -f html -t pdf
        ```
        
        ```bash
        $ cat chan001.v2 \
            | quakeio -a rot:30 -f csmip.v2 -t html -x [*].data \
            | pandoc -f html -t pdf
        ```
        
        
        ### Library
        
        ```python
        import quakeio
        
        csmip_event = quakeio.read("event.zip")
        csmip_event["channel-01"].accel.plot()
        ```
        
        ```python
        csmip_event["chan001"].plot()
        ```
        
        
        ```python
        csmip_event["chan001"].plot_spect()
        ```
        
        ## Command Line Interface
        
        ```
        usage: quakeio [MODE] [OPTIONS] [FILE]
        Options:
        -c/--calculate COMMAND
         
        -f/--from FORMAT
        -t/--to   FORMAT
        
        -x/--exclude FIELD
        
        -m/--metadata=KEY[:VALUE]
        
        Commands:
          husid;
          scale:SCALE;
          rotate:cs=ANGLE;
          filter:<freq>;
          spect;
        
        Formats:
          html
          csmip[.v1,.v2,.v3]
          nga
        ```
        
        <!-- Reference links -->
        [EQSIG]: https://github.com/eng-tools/eqsig
        [CSMIP]: https://www.conservation.ca.gov/cgs/Documents/Program-SMIP/Reports/Other/OSMS_85-03.pdf
        [record-schema]: https://raw.githubusercontent.com/claudioperez/quakeio/master/etc/schemas/record.schema.json
        
        <!-- Badge links -->
        [pypi-d-image]: https://img.shields.io/pypi/dm/quakeio.svg
        [license-badge]: https://img.shields.io/pypi/l/quakeio.svg
        [pypi-d-link]: https://pypi.org/project/quakeio
        [pypi-v-image]: https://img.shields.io/pypi/v/quakeio.svg
        [pypi-v-link]: https://pypi.org/project/quakeio
        [build-img]: https://github.com/claudioperez/quakeio/actions/workflows/base.yml/badge.svg
        [cov-img]: https://raw.githubusercontent.com/claudioperez/quakeio/master/etc/coverage/cov.svg
        [gh-link]: https://github.com/claudioperez/quakeio/compare/0.0.3...master
        [gh-image]: https://img.shields.io/github/commits-since/claudioperez/quakeio/0.0.3?style=social
        
        
        
Keywords: seismic,earthquake,parser
Platform: UNKNOWN
Classifier: Development Status :: 5 - Production/Stable
Classifier: Intended Audience :: Developers
Classifier: License :: OSI Approved :: BSD License
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3 :: Only
Requires-Python: >=3.7
Description-Content-Type: text/markdown
Provides-Extra: testing
Provides-Extra: docs
Provides-Extra: plots
