Skip to main content

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

Project description

https://github.com/seisman/HinetPy/workflows/CI/badge.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://img.shields.io/badge/code%20style-black-000000.svg https://zenodo.org/badge/23509035.svg

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

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

Features

  • Request continuous and event 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

Here is an example showing how to use HinetPy to request continuous waveform data from Hi-net, convert the data into SAC format, and extract instrumental responses as SAC polezero files.

#!/usr/bin/env python
# -*- coding: utf-8 -*-

from HinetPy import Client, win32

# You need a Hi-net account to access the data
client = Client("username", "password")

# Let's try to request 20-minute data starting at 2010-01-01T00:00(GMT+0900)
# of the Hi-net network (with an internal network code of '0101')
data, ctable = client.get_continuous_waveform('0101', '201001010000', 20)

# The request and download process usually takes a few minutes
# waiting for data request ...
# waiting for data download ...

# Now you can see the data and corresponding channel table in your working directory
# waveform data (in win32 format) : 0101_201001010000_20.cnt
# channel table (plaintext file)  : 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 files from the channel table file
win32.extract_pz(ctable)

# Now you can see several SAC and SAC_PZ files in your working directory

# 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.6.7.tar.gz (38.5 kB view details)

Uploaded Source

Built Distribution

HinetPy-0.6.7-py3-none-any.whl (23.9 kB view details)

Uploaded Python 3

File details

Details for the file HinetPy-0.6.7.tar.gz.

File metadata

  • Download URL: HinetPy-0.6.7.tar.gz
  • Upload date:
  • Size: 38.5 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/3.1.1 pkginfo/1.5.0.1 requests/2.23.0 setuptools/41.2.0 requests-toolbelt/0.9.1 tqdm/4.46.1 CPython/3.8.3

File hashes

Hashes for HinetPy-0.6.7.tar.gz
Algorithm Hash digest
SHA256 845cd971c6ad2b3679a0441c80a3dd9ac44a9f9a808233629ae2ad60c1f4c934
MD5 eafbe4b5f9bd08e8f90b5c1988ffa428
BLAKE2b-256 d4752e7c8c83909703df788182d4574b53e83cf83a87dc694a9bcab500540136

See more details on using hashes here.

File details

Details for the file HinetPy-0.6.7-py3-none-any.whl.

File metadata

  • Download URL: HinetPy-0.6.7-py3-none-any.whl
  • Upload date:
  • Size: 23.9 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/3.1.1 pkginfo/1.5.0.1 requests/2.23.0 setuptools/41.2.0 requests-toolbelt/0.9.1 tqdm/4.46.1 CPython/3.8.3

File hashes

Hashes for HinetPy-0.6.7-py3-none-any.whl
Algorithm Hash digest
SHA256 4d63661c7175521d9d14a2143a07fc7bf89e75437d83beec1a444af16fb50268
MD5 0a694dcc47e56b6036033a519608b500
BLAKE2b-256 3275be81f35319a8d7a3be5f68cc2c50f837c6f9dc7145e6459d4eed7fb2102c

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