HinetPy


NameHinetPy JSON
Version 0.8.2 PyPI version JSON
download
home_pageNone
SummaryA Python package to request and process seismic waveform data from NIED Hi-net
upload_time2024-04-05 15:15:13
maintainerNone
docs_urlNone
authorNone
requires_python>=3.8
licenseNone
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://zenodo.org/badge/23509035.svg
    :target: https://zenodo.org/badge/latestdoi/23509035

.. placeholder-for-doc-index

`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/>`__

----

`HinetPy <https://github.com/seisman/HinetPy>`_ is a Python package to request and
process seismic data from `NIED Hi-net <https://www.hinet.bosai.go.jp/>`__.

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.

.. code-block:: python

    #!/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:

.. image:: https://zenodo.org/badge/23509035.svg
    :target: https://zenodo.org/badge/latestdoi/23509035

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/d8/64/22666c5057bc3286f37b30282a88f0d518abbcdbab6018b9f1dcce3b2461/HinetPy-0.8.2.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://zenodo.org/badge/23509035.svg\n    :target: https://zenodo.org/badge/latestdoi/23509035\n\n.. placeholder-for-doc-index\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`HinetPy <https://github.com/seisman/HinetPy>`_ is a Python package to request and\nprocess seismic data from `NIED Hi-net <https://www.hinet.bosai.go.jp/>`__.\n\nFeatures\n========\n\n- Request continuous/event waveform data and event catalog from NIED Hi-net\n- Support networks like Hi-net, F-net, V-net, S-net and more\n- Select Hi-net/F-net stations based on different criteria\n- Convert waveform data from win32 format to SAC format\n- Extract instrumental response as SAC polezero file\n- Multithreads downloading and conversion to speedup\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    #!/usr/bin/env python\n    # -*- coding: utf-8 -*-\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 via:\n\n.. image:: https://zenodo.org/badge/23509035.svg\n    :target: https://zenodo.org/badge/latestdoi/23509035\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 to request and process seismic waveform data from NIED Hi-net",
    "version": "0.8.2",
    "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": "65e9eddfd3480a525fec8af90c7f68f75afa9786e441971f19c7628881458116",
                "md5": "d9762720e7a6b58d8ac92a8fa4ca4b71",
                "sha256": "b38859ad391ad646fb213748fa23dede6bd97ed91ddfcf45a7987b6f931a702d"
            },
            "downloads": -1,
            "filename": "HinetPy-0.8.2-py3-none-any.whl",
            "has_sig": false,
            "md5_digest": "d9762720e7a6b58d8ac92a8fa4ca4b71",
            "packagetype": "bdist_wheel",
            "python_version": "py3",
            "requires_python": ">=3.8",
            "size": 25626,
            "upload_time": "2024-04-05T15:15:10",
            "upload_time_iso_8601": "2024-04-05T15:15:10.600982Z",
            "url": "https://files.pythonhosted.org/packages/65/e9/eddfd3480a525fec8af90c7f68f75afa9786e441971f19c7628881458116/HinetPy-0.8.2-py3-none-any.whl",
            "yanked": false,
            "yanked_reason": null
        },
        {
            "comment_text": "",
            "digests": {
                "blake2b_256": "d86422666c5057bc3286f37b30282a88f0d518abbcdbab6018b9f1dcce3b2461",
                "md5": "bb5dfcf856699971bfd2bc988dabee13",
                "sha256": "c862820162127b7266553ec14246e665c98fd66bf8cfab937243c99595fcde84"
            },
            "downloads": -1,
            "filename": "HinetPy-0.8.2.tar.gz",
            "has_sig": false,
            "md5_digest": "bb5dfcf856699971bfd2bc988dabee13",
            "packagetype": "sdist",
            "python_version": "source",
            "requires_python": ">=3.8",
            "size": 25944,
            "upload_time": "2024-04-05T15:15:13",
            "upload_time_iso_8601": "2024-04-05T15:15:13.528044Z",
            "url": "https://files.pythonhosted.org/packages/d8/64/22666c5057bc3286f37b30282a88f0d518abbcdbab6018b9f1dcce3b2461/HinetPy-0.8.2.tar.gz",
            "yanked": false,
            "yanked_reason": null
        }
    ],
    "upload_time": "2024-04-05 15:15:13",
    "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"
}
        
Elapsed time: 0.21370s