Skip to main content

A NIED Hi-net web service client and win32 tools for seismologists.

Project description

https://img.shields.io/travis/seisman/HinetPy/master.svg https://codecov.io/gh/seisman/HinetPy/branch/master/graph/badge.svg https://img.shields.io/github/release/seisman/HinetPy.svg https://img.shields.io/pypi/v/HinetPy.svg https://img.shields.io/pypi/pyversions/HinetPy.svg https://img.shields.io/github/license/seisman/HinetPy.svg https://zenodo.org/badge/23509035.svg

HinetPy is a Python package aiming to automate and simplify tedious data request, downloading and format conversion tasks related to NIED Hi-net.

NIED Hi-net | Source Code | Documentation | 中文文档

Feature Support

  • Request continuous waveform data from Hi-net

  • Select Hi-net/F-net stations inside a box or circular region

  • Convert waveform data from win32 format to SAC format

  • Extract instrumental response as SAC polezero file

  • Multithreads downloading and conversion to speedup

A simple example

The power of HinetPy makes it simple to request continuous waveform data from Hi-net, convert the data into SAC format and extract instrumental responses as SAC polezero files.

>>> from HinetPy import Client, win32
>>>
>>> # You need a Hi-net account to access their data
>>> client = Client("username", "password")
>>>
>>> # Let's try to request 20 minutes data since 2010-01-01T00:00(GMT+0900) from Hi-net
>>> # '0101' is the code of Hi-net network
>>> data, ctable = client.get_waveform('0101', '201001010000', 20)
>>> # The request and downloading process usually takes several minutes
>>> # waiting data request ...
>>> # waiting data downloading ...
>>> ls  # the downloaded data and corresponding channel table
0101_201001010000_20.cnt 0101_20100101.ch
>>>
>>> # Let's convert data from win32 format to SAC format
>>> win32.extract_sac(data, ctable)
>>> # Let's extract instrument response as PZ file from channel table
>>> win32.extract_pz(ctable)
>>> ls
N.NGUH.E.SAC  N.NGUH.U.SAC  N.NNMH.N.SAC
N.NGUH.N.SAC  N.NNMH.E.SAC  N.NNMH.U.SAC
...
N.NGUH.E.SAC_PZ  N.NGUH.U.SAC_PZ  N.NNMH.N.SAC_PZ
N.NGUH.N.SAC_PZ  N.NNMH.E.SAC_PZ  N.NNMH.U.SAC_PZ
...

Citation

If you find this package useful, please consider citing via:

https://zenodo.org/badge/23509035.svg

License

This project is licensed under the terms of the MIT license.

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

HinetPy-0.4.7.tar.gz (18.4 kB view hashes)

Uploaded Source

Built Distribution

HinetPy-0.4.7-py3-none-any.whl (19.4 kB view hashes)

Uploaded Python 3

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