Skip to main content

A Python package to request and process seismic waveform data from NIED Hi-net

Project description

https://github.com/seisman/HinetPy/actions/workflows/tests.yml/badge.svg https://codecov.io/gh/seisman/HinetPy/branch/main/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

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


HinetPy is a Python package to request and process seismic data from NIED Hi-net.

Features

  • Request continuous/event waveform data and event catalog from NIED Hi-net

  • Support networks like Hi-net, F-net, V-net, S-net and more

  • Select Hi-net/F-net stations based on different criteria

  • 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 of the Hi-net network (with an internal
# network code of '0101') starting at 2010-01-01T00:00 (JST, GMT+0900)
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_sacpz(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.8.3.tar.gz (26.0 kB view details)

Uploaded Source

Built Distribution

HinetPy-0.8.3-py3-none-any.whl (25.6 kB view details)

Uploaded Python 3

File details

Details for the file hinetpy-0.8.3.tar.gz.

File metadata

  • Download URL: hinetpy-0.8.3.tar.gz
  • Upload date:
  • Size: 26.0 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/5.0.0 CPython/3.12.3

File hashes

Hashes for hinetpy-0.8.3.tar.gz
Algorithm Hash digest
SHA256 77be7ea63e0275f3bca45bfa8c9b9b30ab3e33de80a20e87a2429f9628f3ee19
MD5 5fa2b99acf2b5d38e3ae961639f32069
BLAKE2b-256 b3570e2a9719d1cd76fae88ec929cb8d40941235ae2c6cb84de2015df0f99fff

See more details on using hashes here.

File details

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

File metadata

  • Download URL: HinetPy-0.8.3-py3-none-any.whl
  • Upload date:
  • Size: 25.6 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/5.0.0 CPython/3.12.3

File hashes

Hashes for HinetPy-0.8.3-py3-none-any.whl
Algorithm Hash digest
SHA256 62afe6521d4b114de8d3b1220842dab8ba1f41dda842cbff40c773316d7d0563
MD5 c59cb96382be32d9ecdf0ac5b88ffbba
BLAKE2b-256 db707cbe0fa2dda7858a6282d57190cf7d882c18a921313bed84116823be92fc

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