HinetPy

HinetPy: A Python package for accessing and processing NIED Hi-net seismic data - Published in JOSS (2024)

https://github.com/seisman/hinetpy

Science Score: 98.0%

This score indicates how likely this project is to be science-related based on various indicators:

✓
CITATION.cff file
Found CITATION.cff file
✓
codemeta.json file
Found codemeta.json file
✓
.zenodo.json file
Found .zenodo.json file
✓
DOI references
Found 8 DOI reference(s) in README and JOSS metadata
✓
Academic publication links
Links to: joss.theoj.org, zenodo.org
○
Committers with academic emails
○
Institutional organization owner
✓
JOSS paper metadata
Published in Journal of Open Source Software

Keywords

hinet python sac seismology win32

Keywords from Contributors

mesh

Last synced: 4 months ago · JSON representation ·

Repository

A Python package for accessing and processing NIED Hi-net seismic data.

Basic Info

Host: GitHub
Owner: seisman
License: mit
Language: Python
Default Branch: main
Homepage: https://seisman.github.io/HinetPy
Size: 15.2 MB

Statistics

Stars: 89
Watchers: 6
Forks: 39
Open Issues: 1
Releases: 37

Topics

hinet python sac seismology win32

Created over 11 years ago · Last pushed 4 months ago

Metadata Files

Readme License Citation

README.rst

.. 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 `__ |
`Source Code `__ |
`Documentation `__ |
`中文文档 `__

----

.. placeholder-for-doc-index

`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.

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

Owner

Name: Dongdong Tian
Login: seisman
Kind: user
Location: Wuhan, China
Company: China University of Geosciences

Website: https://seisman.info
Repositories: 42
Profile: https://github.com/seisman

Associate Professor in Geophysics at China University of Geosciences. Core developer of @GenericMappingTools.

JOSS Publication

HinetPy: A Python package for accessing and processing NIED Hi-net seismic data

Published

June 25, 2024

DOI

10.21105/joss.06840

Volume 9, Issue 98, Page 6840

Authors

Dongdong Tian

Hubei Subsurface Multi-scale Imaging Key Laboratory, School of Geophysics and Geomatics, China University of Geosciences, Wuhan 430074, China

Editor

Jayaram Hariharan

Citation (CITATION.cff)

# YAML 1.2
# Metadata for citation of this software according to the CFF format (https://citation-file-format.github.io/)
cff-version: "1.2.0"
message: If you use this software, please cite our article in the Journal of Open Source Software.
title: "HinetPy: A Python package for accessing and processing NIED Hi-net seismic data"
authors:
- family-names: Tian
  given-names: Dongdong
  orcid: "https://orcid.org/0000-0001-7967-1197"
version: 0.10.0
date-released: 2024-11-21
doi: 10.5281/zenodo.14193527
type: software
license: MIT
repository-code: "https://github.com/seisman/HinetPy"
preferred-citation:
  title: "HinetPy: A Python package for accessing and processing NIED Hi-net seismic data"
  authors:
  - family-names: Tian
    given-names: Dongdong
    orcid: "https://orcid.org/0000-0001-7967-1197"
  date-published: 2024-06-25
  doi: 10.21105/joss.06840
  volume: 9
  issue: 98
  start: 6840
  journal: Journal of Open Source Software
  issn: 2475-9066
  publisher:
    name: Open Journals
  type: article
  url: "https://joss.theoj.org/papers/10.21105/joss.06840"

GitHub Events

Total

Release event: 1
Watch event: 9
Delete event: 4
Push event: 12
Pull request event: 8
Fork event: 2
Create event: 6

Last Year

Release event: 1
Watch event: 9
Delete event: 4
Push event: 12
Pull request event: 8
Fork event: 2
Create event: 6

Committers

Last synced: 5 months ago

All Time

Total Commits: 672
Total Committers: 5
Avg Commits per committer: 134.4
Development Distribution Score (DDS): 0.083

Past Year

Commits: 13
Committers: 2
Avg Commits per committer: 6.5
Development Distribution Score (DDS): 0.462

Top Committers

Name	Email	Commits
Dongdong Tian	s**o@g**m	616
dependabot[bot]	4****]	53
junlysky	l**s@g**m	1
Yasu Sawaki	5****1	1
Marius Kriegerowski	m**i@g**e	1

Committer Domains (Top 20 + Academic)

gfz-potsdam.de: 1

Issues and Pull Requests

Last synced: 4 months ago

All Time

Total issues: 35
Total pull requests: 96
Average time to close issues: 4 months
Average time to close pull requests: 14 days
Total issue authors: 11
Total pull request authors: 6
Average comments per issue: 1.69
Average comments per pull request: 0.18
Merged pull requests: 87
Bot issues: 0
Bot pull requests: 56

Past Year

Issues: 0
Pull requests: 10
Average time to close issues: N/A
Average time to close pull requests: about 8 hours
Issue authors: 0
Pull request authors: 1
Average comments per issue: 0
Average comments per pull request: 0.0
Merged pull requests: 7
Bot issues: 0
Bot pull requests: 10

View more stats

Top Authors

Issue Authors

seisman (22)
zhong-yy (4)
xumi1993 (1)
peanut-butterabc (1)
mary-tsekhmistrenko (1)
stefanazzz (1)
Faisal-Umer (1)
rokuwaki (1)
JameAtkins (1)
YuYifan2000 (1)
HerrMuellerluedenscheid (1)
Lucile-Costes (1)

Pull Request Authors

dependabot[bot] (65)
seisman (42)
junlysky (2)
mnagaso (1)
yasuit21 (1)
HerrMuellerluedenscheid (1)

Top Labels

Issue Labels

bug (4) enhancement (1)

Pull Request Labels

dependencies (65) github_actions (1)

Packages

Total packages: 1
Total downloads:
- pypi 211 last-month

Total dependent packages: 0
Total dependent repositories: 1
Total versions: 33
Total maintainers: 1

pypi.org: hinetpy

A Python package for accessing and processing NIED Hi-net seismic data

Documentation: https://hinetpy.readthedocs.io/
License: MIT License
Latest release: 0.10.0
published about 1 year ago

Versions: 33
Dependent Packages: 0
Dependent Repositories: 1
Downloads: 211 Last month

Rankings

Forks count: 6.7%

Stargazers count: 8.3%

Dependent packages count: 10.1%

Average: 13.8%

Dependent repos count: 21.6%

Downloads: 22.3%

Maintainers (1)

seisman

Last synced: 4 months ago

Dependencies

requirements-dev.txt pypi

black * development
blackdoc * development
codecov * development
coverage * development
flake8 * development
isort * development
pytest >=6.0 development
pytest-cov * development
sphinx * development
sphinx-intl * development
sphinx_rtd_theme * development

requirements.txt pypi

requests *

.github/workflows/check.yml actions

actions/checkout v3 composite
actions/setup-python v4 composite
styfle/cancel-workflow-action 0.11.0 composite

.github/workflows/docs.yml actions

actions/checkout v3 composite
actions/setup-python v4 composite
peaceiris/actions-gh-pages v3.9.1 composite
styfle/cancel-workflow-action 0.11.0 composite

.github/workflows/pypi-publish.yml actions

actions/checkout v3 composite
actions/setup-python v4 composite
pypa/gh-action-pypi-publish v1.6.4 composite

.github/workflows/tests.yml actions

actions/checkout v3 composite
actions/setup-python v4 composite
codecov/codecov-action v3 composite
styfle/cancel-workflow-action 0.11.0 composite

pyproject.toml pypi

setup.py pypi

HinetPy

Science Score: 98.0%

Keywords

Keywords from Contributors

Repository

Basic Info

Statistics

Topics

Metadata Files

README.rst

Owner

JOSS Publication

HinetPy: A Python package for accessing and processing NIED Hi-net seismic data

Authors

Editor

Tags

Citation (CITATION.cff)

GitHub Events

Total

Last Year

Committers

All Time

Past Year

Top Committers

Committer Domains (Top 20 + Academic)

Issues and Pull Requests

All Time

Past Year

Top Authors

Issue Authors

Pull Request Authors

Top Labels

Issue Labels

Pull Request Labels

Packages

pypi.org: hinetpy

Rankings

Maintainers (1)

Dependencies