NIED Hi-net | Source Code | Documentation | 中文文档
HinetPy is a Python package for accessing and processing seismic data from NIED Hi-net.
Key Features
- Facilitates easy access to NIED Hi-net seismic data, including continuous/event waveform data and event catalogs.
- Supports multiple seismic networks (e.g., F-net, S-net, MeSO-net and more in addition to Hi-net) in Japan.
- Selects a subset of stations based on geographical location or station name (supports Hi-net, F-net, S-net and MeSO-net only).
- Converts waveform data to SAC format and instrumental responses to SAC polezero files.
- Speeds up the downloading and processing workflow via the use of multithreading.
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.
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 the package in either of the following ways:
Cite the HinetPy paper (preferred)
A formal paper is published in The Journal of Open Source Software since HinetPy v0.9.0. This is the preferred way for citation.
Tian, D. (2024). HinetPy: A Python package for accessing and processing NIED Hi-net seismic data. Journal of Open Source Software, 9(98), 6840. https://doi.org/10.21105/joss.06840
Cite a specific HinetPy version
If you'd like to cite a specific HinetPy version, you can visit Zenodo, choose the version you want to cite, and cite like this:
Tian, D. (20XX). HinetPy: A Python package for accessing and processing NIED Hi-net seismic data (X.X.X). Zenodo. https://doi.org/10.5281/zenodo.xxxxxxxx
Contributing
Feedback and contributions are welcome. Please feel free to open an issue or pull request if you have any suggestions or would like to contribute a feature. For additional information or specific questions, please open an issue directly.
License
This project is licensed under the terms of the MIT license.
1 maintainer
Metadata
1 maintainer
Release files for HinetPy 0.13.0
For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.
Source distribution (sdist)
| File | Size | Uploaded | |
|---|---|---|---|
| hinetpy-0.13.0.tar.gz | 27.5 kB | Details |
Built distribution (wheel)
| File | Interpreter | ABI | Platform | Reset |
|---|---|---|---|---|
| hinetpy-0.13.0-py3-none-any.whl | Python 3 | none | any | Details |
Total release size: 56.1 kB
Release files / hinetpy-0.13.0.tar.gz
| Download URL | hinetpy-0.13.0.tar.gz |
|---|---|
| Size | 27.5 kB |
| Tags | Source |
|
SHA-256 checksum How to use checksums |
a06400952af1738935737609c6da76dd5b8b538bdc74ec77f50462010db9f954
|
|
BLAKE2b-256 checksum How to use checksums |
fa84e94d3d720ec4e3e178aab398f6bac704f5537f44aed7c7a69bb51dd3c014
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
| Uploaded via |
twine/6.1.0 CPython/3.13.13
|
Release files / hinetpy-0.13.0-py3-none-any.whl
| Download URL | hinetpy-0.13.0-py3-none-any.whl |
|---|---|
| Size | 28.6 kB |
| Tags | Python 3 |
|
SHA-256 checksum How to use checksums |
0212c18d5ee382f4c18560c6cae68e3f484a50655d5c68f3df7194b4d04ab04f
|
|
BLAKE2b-256 checksum How to use checksums |
829f5ad4eebcdb5d11f1cc9a98523281588587939d3d73e9d1a837a42ef5aac8
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
| Uploaded via |
twine/6.1.0 CPython/3.13.13
|
