A seismology toolkit for Python
You can not select more than 25 topics Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.

86 lines
3.0 KiB

5 years ago
4 years ago
4 years ago
3 years ago
3 years ago
4 years ago
4 years ago
4 years ago
4 years ago
4 years ago
4 years ago
4 years ago
4 years ago
4 years ago
4 years ago
4 years ago
4 years ago
  1. # Pyrocko
  2. ### _A seismology toolkit for Python_
  3. [![Build Status](https://drone.pyrocko.org/api/badges/pyrocko/pyrocko/status.svg?ref=refs/heads/master)](https://drone.pyrocko.org/pyrocko/pyrocko)
  4. [![Anaconda-Server Badge](https://anaconda.org/pyrocko/pyrocko/badges/installer/conda.svg)](https://conda.anaconda.org/pyrocko)
  5. [![PyPI](https://img.shields.io/pypi/v/pyrocko.svg)](https://pypi.python.org/pypi/pyrocko/)
  6. ## Installation
  7. Full installation instructions are available at
  8. https://pyrocko.org/docs/current/install/.
  9. ### System wide installation from source
  10. ```
  11. git clone https://git.pyrocko.org/pyrocko/pyrocko
  12. cd pyrocko
  13. sudo python install_prerequisites.py
  14. sudo python setup.py install
  15. ```
  16. ### Installation with Anaconda / MacOSX
  17. ```
  18. conda install -c pyrocko pyrocko
  19. ```
  20. Anaconda2/3 Packages are available for Linux and OSX
  21. ### User installation with Python PIP
  22. ```
  23. pip install --user pyrocko
  24. pip install --user --only-binary :all: PyQt5
  25. ```
  26. or from source
  27. ```
  28. git clone https://git.pyrocko.org/pyrocko/pyrocko
  29. cd pyrocko
  30. pip install --user -r requirements.txt
  31. pip install --user .
  32. ```
  33. ## Documentation
  34. Documentation and usage examples are available online at https://pyrocko.org/docs/current
  35. ## Community Support
  36. Community support at [https://hive.pyrocko.org](https://hive.pyrocko.org/signup_user_complete/?id=9edryhxeptdbmxrecbwy3zg49y).
  37. ## Citation
  38. The recommended citation for Pyrocko is: (You can find the BibTeX snippet in the
  39. [`CITATION` file](CITATION.bib)):
  40. > Heimann, Sebastian; Kriegerowski, Marius; Isken, Marius; Cesca, Simone; Daout, Simon; Grigoli, Francesco; Juretzek, Carina; Megies, Tobias; Nooshiri, Nima; Steinberg, Andreas; Sudhaus, Henriette; Vasyura-Bathke, Hannes; Willey, Timothy; Dahm, Torsten (2017): Pyrocko - An open-source seismology toolbox and library. V. 0.3. GFZ Data Services. https://doi.org/10.5880/GFZ.2.1.2017.001
  41. [![DOI](https://img.shields.io/badge/DOI-10.5880%2FGFZ.2.1.2017.001-blue.svg)](https://doi.org/10.5880/GFZ.2.1.2017.001)
  42. ## License
  43. GNU General Public License, Version 3, 29 June 2007
  44. Copyright © 2017 Helmholtz Centre Potsdam GFZ German Research Centre for Geosciences, Potsdam, Germany
  45. Pyrocko is free software: you can redistribute it and/or modify it under the terms of the GNU General Public License as published by the Free Software Foundation, either version 3 of the License, or (at your option) any later version.
  46. Pyrocko is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for more details.
  47. You should have received a copy of the GNU General Public License along with this program. If not, see <http://www.gnu.org/licenses/>.
  48. ## Contact
  49. * Sebastian Heimann;
  50. sebastian.heimann@gfz-potsdam.de
  51. * Marius Isken;
  52. marius.isken@gfz-potsdam.de
  53. * Marius Kriegerowski;
  54. marius.kriegerowski@gfz-potsdam.de
  55. ```
  56. Helmholtz Centre Potsdam German Research Centre for Geoscienes GFZ
  57. Section 2.1: Physics of Earthquakes and Volcanoes
  58. Helmholtzstraße 6/7
  59. 14467 Potsdam, Germany
  60. ```