Skip to main content

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

Project description

https://github.com/seisman/HinetPy/actions/workflows/tests.yml/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.9.tar.gz (38.9 kB view details)

Uploaded Source

Built Distribution

HinetPy-0.6.9-py3-none-any.whl (24.0 kB view details)

Uploaded Python 3

File details

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

File metadata

  • Download URL: HinetPy-0.6.9.tar.gz
  • Upload date:
  • Size: 38.9 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/3.4.1 importlib_metadata/4.0.1 pkginfo/1.7.0 requests/2.25.1 requests-toolbelt/0.9.1 tqdm/4.60.0 CPython/3.9.5

File hashes

Hashes for HinetPy-0.6.9.tar.gz
Algorithm Hash digest
SHA256 68fa630b631f4dbd9cc3b971cf6f201cb7fbab441c2d214a8753a53f92f80028
MD5 35a8483f9ee13781fa6ef3bc79e59741
BLAKE2b-256 fe174544fcc01587691453c3f9ebad3e6d5b96d8a6ecd66ffc440af12be7bb66

See more details on using hashes here.

File details

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

File metadata

  • Download URL: HinetPy-0.6.9-py3-none-any.whl
  • Upload date:
  • Size: 24.0 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/3.4.1 importlib_metadata/4.0.1 pkginfo/1.7.0 requests/2.25.1 requests-toolbelt/0.9.1 tqdm/4.60.0 CPython/3.9.5

File hashes

Hashes for HinetPy-0.6.9-py3-none-any.whl
Algorithm Hash digest
SHA256 59fc508e3e5c06de53b82e0dcaee7dace07239c91366a4513002db39267696e2
MD5 4158c579473f48a7b45ffe917bb2aa6e
BLAKE2b-256 767f415dd35307cdfa58ef071b69afc168cbb88e52d0d5c839e6b90015fb72cf

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