Overview | Features | Tools | Installation | Documentation | License | Citation | Contributing |
PySeis is a Python package for environmental seismology, a scientific field that studies the seismic signals emitted by Earth surface processes. This package provides a suite of tools to facilitate the reading, writing, preparation, analysis, and visualization of seismic data, drawing inspiration from the functionality of the eseis package in R.
While the eseis package in R offers tools for seismological data analysis, there was a gap in equivalent functionality within the Python ecosystem. PySeis aims to bridge this gap by providing Python users with a comparable suite of tools, ensuring they can perform environmental seismology tasks efficiently within a Python environment.
✔️ Fluvial data inversion
✔️ Reference model creation
✔️ Spatial distance calculation
✔️ Spatial signals migration
✔️ Spatial data clipping
✔️ Coordinate conversion
✔️ Source location detection
✔️ Source tracking
✔️ Spectrum modeling
The following tools were used in this project:
Before starting 🏁, you need to have Git and Python installed.
# Clone this project
$ git clone https://gitup.uni-potsdam.de/tautz1/pyseis.git
# Access
$ cd pyseis
# Activate your virtual environment (optional)
# Install the pyseis package
$ pip install .
# To see the data analysis workflow, install snakemake and run
$ snakemake -s workflow/snakefile -j 1 --latency-wait 60
To see Pyseis documentation open this in your browser.
If you use this software, please cite it using this file.
All contributions, bug reports, bug fixes, documentation improvements, enhancements, and ideas are welcome.
A detailed overview on how to contribute can be found in the contributing guide. Feel free to create new issues and start working on it!
As contributors and maintainers to this project, you are expected to abide by Pyseis' code of conduct.
More information can be found at: Code of Conduct