https://github.com/geoscienceaustralia/hiperseis
High Performance Seismologic Data and Metadata Processing System
https://github.com/geoscienceaustralia/hiperseis
geophysics inversion seismology tomography
Last synced: 3 months ago
JSON representation
High Performance Seismologic Data and Metadata Processing System
- Host: GitHub
- URL: https://github.com/geoscienceaustralia/hiperseis
- Owner: GeoscienceAustralia
- License: gpl-3.0
- Created: 2017-04-05T03:57:13.000Z (about 8 years ago)
- Default Branch: develop
- Last Pushed: 2025-02-19T04:47:08.000Z (4 months ago)
- Last Synced: 2025-03-30T10:09:01.848Z (3 months ago)
- Topics: geophysics, inversion, seismology, tomography
- Language: Jupyter Notebook
- Homepage:
- Size: 436 MB
- Stars: 59
- Watchers: 39
- Forks: 23
- Open Issues: 7
-
Metadata Files:
- Readme: README.rst
- Changelog: HISTORY.rst
- License: LICENSE
Awesome Lists containing this project
README
HiPerSeis: High Performance Software Package for Seismology Data/Metadata Processing and Analysis
=================================================================================================
|Build Status| |Coverage Status| |Documentation Status|
How to Cite
===========
If you use this software in a scientific publication, we'd very much appreciate if you could cite the following papers:
- Hassan, R., Hejrani, B., Medlin, A., Gorbatov, A. and Zhang, F., 2020. High-performance seismological tools (HiPerSeis). In: Czarnota, K., Roach, I., Abbott, S., Haynes, M., Kositcin, N., Ray, A. and Slatter, E. (eds.) Exploring for the Future: Extended Abstracts, Geoscience Australia, Canberra, 1–4. https://ecat.ga.gov.au/geonetwork/srv/eng/catalog.search#/metadata/135095
Overview
========
- Home Page: https://github.com/GeoscienceAustralia/hiperseis
- Documentation: http://hiperseis.readthedocs.io/en/develop/
- Wiki Pages: https://github.com/GeoscienceAustralia/hiperseis/wiki
Current Contacts
================
- Rakib Hassan: [email protected]
- Alexei Gorbatov: [email protected]
- Babak Hejrani: [email protected]
System Requirements
==========================
- Python 3.6 (recommended)
Setup Guide
=================================
1. First, obtain the source code from `Github repository `_
- ``git clone https://github.com/GeoscienceAustralia/hiperseis.git``
- ``cd hiperseis``
- ``git submodule update --init --recursive``
2. HiPerSeis does not provide an installation script due to the number of dependencies involved, some of which require low-level libraries to be available on the host machine. Instead, shell scripts are provided in ``hiperseis/setup_scripts`` for Linux, OSX and Windows for installing dependencies through a combination of Conda and Pip. A shell script is provided for NCI GADI, tailored exclusively for the current list of low-level HPC libraries e.g. MPI, HDF5, etc. available on the system.
3. To use HiPerSeis in the checked out location, you will need to add the root HiPerSeis folder to your PYTHONPATH variable. For example, if you checked out HiPerSeis to the folder `dev/hiperseis` relative to your home directory, then in a `bash` shell you need to execute the following shell command: ``export PYTHONPATH=$HOME/dev/hiperseis``. This needs to be done for each command shell session, or added to ``.bashrc`` or its equivalent.
Third Party Library Dependencies
================================
Certain modules require specific third party (non-Python) libraries to be installed
on the host system. For example, scripts that convert to sc3ml format also require Seiscomp3 to be
installed and to be visible in the PATH.
License
===============
HiPerSeis is licensed under the GPL version 3
.. |Coverage Status| image:: https://coveralls.io/repos/github/GeoscienceAustralia/hiperseis/badge.svg
:target: https://coveralls.io/github/GeoscienceAustralia/hiperseis
.. |Documentation Status| image:: https://readthedocs.org/projects/hiperseis/badge/?version=develop
:target: http://hiperseis.readthedocs.io/en/develop/