Skip to main content

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

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://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.0.tar.gz (25.6 kB view details)

Uploaded Source

Built Distribution

HinetPy-0.8.0-py3-none-any.whl (25.4 kB view details)

Uploaded Python 3

File details

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

File metadata

  • Download URL: HinetPy-0.8.0.tar.gz
  • Upload date:
  • Size: 25.6 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/5.0.0 CPython/3.12.2

File hashes

Hashes for HinetPy-0.8.0.tar.gz
Algorithm Hash digest
SHA256 1b9f2e29ca04cea013caa8a13855522db80b9535be806df59d026da5ea2dc73b
MD5 bb0a6a9914b05ad9c94daabcbf078920
BLAKE2b-256 c3c0ffb8da3df1427bd3978def81cb97bf94ed589f4d04e6e178f50dfb3daf9f

See more details on using hashes here.

File details

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

File metadata

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

File hashes

Hashes for HinetPy-0.8.0-py3-none-any.whl
Algorithm Hash digest
SHA256 0acef33aacc1ee5ef88404e958ff42711f73e5c24c7076dfd86c7a06b4eb4862
MD5 e27e12468c2a98841e4212a6c0adbd4b
BLAKE2b-256 5242a2f402fbaa1c25f8ac312488d0ae1f13ca9646412e11f75a7850e55519d2

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