| Name | HinetPy JSON |
| Version |
0.10.0
JSON |
| download |
| home_page | None |
| Summary | A Python package for accessing and processing NIED Hi-net seismic data |
| upload_time | 2024-11-20 16:32:19 |
| maintainer | None |
| docs_url | None |
| author | None |
| requires_python | >=3.8 |
| license | None |
| keywords |
seismology
nied
hi-net
waveform
|
| VCS |
 |
| bugtrack_url |
|
| requirements |
No requirements were recorded.
|
| Travis-CI |
No Travis.
|
| coveralls test coverage |
No coveralls.
|
.. image:: https://github.com/seisman/HinetPy/actions/workflows/tests.yml/badge.svg
:target: https://github.com/seisman/HinetPy/actions/workflows/tests.yml
.. image:: https://codecov.io/gh/seisman/HinetPy/branch/main/graph/badge.svg
:target: https://codecov.io/gh/seisman/HinetPy
.. image:: https://img.shields.io/github/release/seisman/HinetPy.svg
:target: https://github.com/seisman/HinetPy/releases
.. image:: https://img.shields.io/pypi/v/HinetPy.svg
:target: https://pypi.org/project/HinetPy/
.. image:: https://img.shields.io/pypi/pyversions/HinetPy.svg
:target: https://pypi.org/project/HinetPy/
.. image:: https://img.shields.io/github/license/seisman/HinetPy.svg
:target: https://github.com/seisman/HinetPy/blob/main/LICENSE
.. image:: https://joss.theoj.org/papers/10.21105/joss.06840/status.svg
:target: https://doi.org/10.21105/joss.06840
.. image:: https://zenodo.org/badge/23509035.svg
:target: https://zenodo.org/badge/latestdoi/23509035
`NIED Hi-net <https://www.hinet.bosai.go.jp/>`__ |
`Source Code <https://github.com/seisman/HinetPy>`__ |
`Documentation <https://seisman.github.io/HinetPy>`__ |
`中文文档 <https://seisman.github.io/HinetPy/zh_CN/>`__
----
.. placeholder-for-doc-index
`HinetPy <https://github.com/seisman/HinetPy>`_ is a Python package for accessing and
processing seismic data from `NIED Hi-net <https://www.hinet.bosai.go.jp/>`__.
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.
.. code-block:: python
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 on `The Journal of Open Source Software <https://joss.theoj.org/>`__
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 <https://zenodo.org/records/12523911>`__, 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.
Raw data
{
"_id": null,
"home_page": null,
"name": "HinetPy",
"maintainer": null,
"docs_url": null,
"requires_python": ">=3.8",
"maintainer_email": null,
"keywords": "seismology, NIED, Hi-net, waveform",
"author": null,
"author_email": "Dongdong Tian <seisman.info@gmail.com>",
"download_url": "https://files.pythonhosted.org/packages/f2/93/a49763b7cd29c69ee9f01b9d32cac99ec41788c98e7c0fe0452c28023ac3/hinetpy-0.10.0.tar.gz",
"platform": null,
"description": ".. image:: https://github.com/seisman/HinetPy/actions/workflows/tests.yml/badge.svg\n :target: https://github.com/seisman/HinetPy/actions/workflows/tests.yml\n.. image:: https://codecov.io/gh/seisman/HinetPy/branch/main/graph/badge.svg\n :target: https://codecov.io/gh/seisman/HinetPy\n.. image:: https://img.shields.io/github/release/seisman/HinetPy.svg\n :target: https://github.com/seisman/HinetPy/releases\n.. image:: https://img.shields.io/pypi/v/HinetPy.svg\n :target: https://pypi.org/project/HinetPy/\n.. image:: https://img.shields.io/pypi/pyversions/HinetPy.svg\n :target: https://pypi.org/project/HinetPy/\n.. image:: https://img.shields.io/github/license/seisman/HinetPy.svg\n :target: https://github.com/seisman/HinetPy/blob/main/LICENSE\n.. image:: https://joss.theoj.org/papers/10.21105/joss.06840/status.svg\n :target: https://doi.org/10.21105/joss.06840\n.. image:: https://zenodo.org/badge/23509035.svg\n :target: https://zenodo.org/badge/latestdoi/23509035\n\n\n`NIED Hi-net <https://www.hinet.bosai.go.jp/>`__ |\n`Source Code <https://github.com/seisman/HinetPy>`__ |\n`Documentation <https://seisman.github.io/HinetPy>`__ |\n`\u4e2d\u6587\u6587\u6863 <https://seisman.github.io/HinetPy/zh_CN/>`__\n\n----\n\n.. placeholder-for-doc-index\n\n`HinetPy <https://github.com/seisman/HinetPy>`_ is a Python package for accessing and\nprocessing seismic data from `NIED Hi-net <https://www.hinet.bosai.go.jp/>`__.\n\nKey Features\n============\n\n- Facilitates easy access to NIED Hi-net seismic data, including continuous/event\n waveform data and event catalogs.\n- Supports multiple seismic networks (e.g., F-net, S-net, MeSO-net and more in addition\n to Hi-net) in Japan.\n- Selects a subset of stations based on geographical location or station name (Supports\n Hi-net, F-net, S-net and MeSO-net only).\n- Converts waveform data to SAC format and instrumental responses to SAC polezero files.\n- Speeds up the downloading and processing workflow via the use of multithreading.\n\nA simple example\n================\n\nHere is an example showing how to use HinetPy to request continuous waveform data from\nHi-net, convert the data into SAC format, and extract instrumental responses as SAC\npolezero files.\n\n.. code-block:: python\n\n from HinetPy import Client, win32\n\n # You need a Hi-net account to access the data\n client = Client(\"username\", \"password\")\n\n # Let's try to request 20-minute data of the Hi-net network (with an internal\n # network code of '0101') starting at 2010-01-01T00:00 (JST, GMT+0900)\n data, ctable = client.get_continuous_waveform(\"0101\", \"201001010000\", 20)\n\n # The request and download process usually takes a few minutes\n # waiting for data request ...\n # waiting for data download ...\n\n # Now you can see the data and corresponding channel table in your working directory\n # waveform data (in win32 format) : 0101_201001010000_20.cnt\n # channel table (plaintext file) : 0101_20100101.ch\n\n # Let's convert data from win32 format to SAC format\n win32.extract_sac(data, ctable)\n\n # Let's extract instrument response as PZ files from the channel table file\n win32.extract_sacpz(ctable)\n\n # Now you can see several SAC and SAC_PZ files in your working directory\n\n # N.NGUH.E.SAC N.NGUH.U.SAC N.NNMH.N.SAC\n # N.NGUH.N.SAC N.NNMH.E.SAC N.NNMH.U.SAC\n # ...\n # N.NGUH.E.SAC_PZ N.NGUH.U.SAC_PZ N.NNMH.N.SAC_PZ\n # N.NGUH.N.SAC_PZ N.NNMH.E.SAC_PZ N.NNMH.U.SAC_PZ\n # ...\n\nCitation\n========\n\nIf you find this package useful, please consider citing the package in either of the\nfollowing ways:\n\n**Cite the HinetPy paper (preferred)**\n\nA formal paper is published on `The Journal of Open Source Software <https://joss.theoj.org/>`__\nsince HinetPy v0.9.0. This is the **preferred** way for citation.\n\n Tian, D. (2024). HinetPy: A Python package for accessing and processing NIED Hi-net seismic data.\n Journal of Open Source Software, 9(98), 6840. https://doi.org/10.21105/joss.06840\n\n**Cite a specific HinetPy version**\n\nIf you'd like to cite a specific HinetPy version, you can visit\n`Zenodo <https://zenodo.org/records/12523911>`__, choose the version you want to cite,\nand cite like this:\n\n Tian, D. (20XX). HinetPy: A Python package for accessing and processing NIED Hi-net seismic data (X.X.X).\n Zenodo. https://doi.org/10.5281/zenodo.xxxxxxxx\n\nContributing\n============\n\nFeedback and contributions are welcome! Please feel free to open an issue or pull\nrequest if you have any suggestions or would like to contribute a feature.\nFor additional information or specific questions, please open an issue directly.\n\nLicense\n=======\n\nThis project is licensed under the terms of the MIT license.\n",
"bugtrack_url": null,
"license": null,
"summary": "A Python package for accessing and processing NIED Hi-net seismic data",
"version": "0.10.0",
"project_urls": {
"documentation": "https://seisman.github.io/HinetPy/",
"homepage": "https://seisman.github.io/HinetPy/",
"repository": "https://github.com/seisman/HinetPy"
},
"split_keywords": [
"seismology",
" nied",
" hi-net",
" waveform"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "8370d49d72910e82c286facf1d644f932db58e023c2bb694f7c022de50e22d46",
"md5": "c0418ee6b1b56ca2ba89f85657d00f3a",
"sha256": "f6c72aaec94f36a233093f552c42b9b42437174c18c2f95c729cd152653226fa"
},
"downloads": -1,
"filename": "HinetPy-0.10.0-py3-none-any.whl",
"has_sig": false,
"md5_digest": "c0418ee6b1b56ca2ba89f85657d00f3a",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.8",
"size": 27320,
"upload_time": "2024-11-20T16:32:16",
"upload_time_iso_8601": "2024-11-20T16:32:16.697730Z",
"url": "https://files.pythonhosted.org/packages/83/70/d49d72910e82c286facf1d644f932db58e023c2bb694f7c022de50e22d46/HinetPy-0.10.0-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "f293a49763b7cd29c69ee9f01b9d32cac99ec41788c98e7c0fe0452c28023ac3",
"md5": "38dedebe086e997bb779cbc866c81949",
"sha256": "f32c1460bbd4d6caf086c27f610d5eef5fb2bfa63be6e24c1931a206b214482d"
},
"downloads": -1,
"filename": "hinetpy-0.10.0.tar.gz",
"has_sig": false,
"md5_digest": "38dedebe086e997bb779cbc866c81949",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.8",
"size": 26865,
"upload_time": "2024-11-20T16:32:19",
"upload_time_iso_8601": "2024-11-20T16:32:19.048648Z",
"url": "https://files.pythonhosted.org/packages/f2/93/a49763b7cd29c69ee9f01b9d32cac99ec41788c98e7c0fe0452c28023ac3/hinetpy-0.10.0.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-11-20 16:32:19",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "seisman",
"github_project": "HinetPy",
"travis_ci": false,
"coveralls": false,
"github_actions": true,
"requirements": [],
"lcname": "hinetpy"
}
