diff --git a/README.rst b/README.rst index 3d6c73e8..b564f4e9 100644 --- a/README.rst +++ b/README.rst @@ -24,18 +24,20 @@ ---- -`HinetPy `_ is a Python package to request and -process seismic data from `NIED Hi-net `__. +`HinetPy `_ is a Python package for accessing and +processing seismic data from `NIED Hi-net `__. -Features -======== +Key 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 +- 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 ================ @@ -46,9 +48,6 @@ 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 @@ -84,10 +83,25 @@ polezero files. Citation ======== -If you find this package useful, please consider citing via: +If you find this package useful, please consider cite the package in either of the +following ways: -.. image:: https://zenodo.org/badge/23509035.svg - :target: https://zenodo.org/badge/latestdoi/23509035 +**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 ============