You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
PyCSEP can be installed in several ways. It can be installed using conda or pip package managers or from the
30
-
source code found in the PyCSEP github repo. Researchers interested in contributing to PyCSEP development should
31
-
install PyCSEP from source code. PyCSEP depends on the following software packages.
29
+
pyCSEP can be installed in several ways. It can be installed using conda or pip package managers or from the
30
+
source code found in the pyCSEP github repo. Researchers interested in contributing to pyCSEP development should
31
+
install pyCSEP from source code. pyCSEP depends on the following software packages.
32
32
These which may be installed automatically, or manually, depending on the installation method used.
33
33
* Python 3.7 or later (https://python.org)
34
-
* NumPy 1.10 or later (https://numpy.org)
35
-
* GEOS 3.3.3 or later (https://trac.osgeo.org/geos/)
36
-
* PROJ 4.9.0 or later (https://proj4.org/)
34
+
* NumPy 1.21.3 or later (https://numpy.org)
35
+
* SciPy 1.7.1 or later (https://scipy.org)
36
+
* pandas 1.3.4 or later (https://pandas.pydata.org)
37
+
* cartopy 0.20.0 or later (https://scitools.org.uk/cartopy/docs/latest)
38
+
* GEOS 3.7.2 or later (https://trac.osgeo.org/geos/)
39
+
* PROJ 8.0.0 or later (https://proj.org/)
37
40
38
-
[Detailed PyCSEP Installation Instructions](https://docs.cseptesting.org/getting_started/installing.html) can be found in the online PyCSEP documentation.
41
+
Please see the [requirements file](https://github.com/SCECcode/pycsep/blob/master/requirements.yml) for a complete list
42
+
of requirements. These are installed automatically when using the `conda` distribution.
43
+
44
+
Detailed pyCSEP [installation instructions](https://docs.cseptesting.org/getting_started/installing.html) can be found
45
+
in the online pyCSEP documentation.
39
46
40
47
# Usage:
41
-
Once installed, PyCSEP methods can be invoked from python code by importing package csep. PyCSEP provides objects and utilities related to several key concepts:
48
+
Once installed, pyCSEP methods can be invoked from python code by importing package csep. pyCSEP provides objects and
49
+
utilities related to several key concepts:
42
50
* Earthquake Catalogs
43
51
* Earthquake Forecasts
44
52
* Earthquake Forecast Evaluations
45
53
* Regions
46
54
47
-
An example of PyCSEP catalog operations is shown below:
55
+
An simple example to download and plot an earthquake catalog from the USGS ComCat:
Please see [PyCSEP Getting Started](https://docs.cseptesting.org/getting_started/core_concepts) documentation for more examples and tutorials.
66
+
Please see [pyCSEP Getting Started](https://docs.cseptesting.org/getting_started/core_concepts) documentation for more examples and tutorials.
59
67
60
68
# Software Support:
61
-
Software support for PyCSEP is provided by that Southern California Earthquake Center (SCEC) Research Computing Group. This group supports several research software distributions including UCVM. Users can report issues and feature requests using the PyCSEP github-based issue tracking link below. Developers will also respond to emails sent to the SCEC software contact listed below.
2. Email Contact: software [at] scec [dot] usc [dot] edu
64
74
65
75
# Contributing:
66
-
We welcome contributions to the PyCSEP Toolkit. If you would like to contribute to this package, including software, tests, and documentation,
67
-
please visit the [contribution guidelines](https://github.com/SCECcode/pycsep/blob/master/CONTRIBUTING.md) for guidelines on how to contribute to PyCSEP development.
68
-
PyCSEP contributors agree to abide by the code of conduct found in our [Code of Conduct](CODE_OF_CONDUCT.md) guidelines.
76
+
We welcome contributions to the pyCSEP Toolkit. If you would like to contribute to this package, including software, tests, and documentation,
77
+
please visit the [contribution guidelines](https://github.com/SCECcode/pycsep/blob/master/CONTRIBUTING.md) for guidelines on how to contribute to pyCSEP development.
78
+
pyCSEP contributors agree to abide by the code of conduct found in our [Code of Conduct](CODE_OF_CONDUCT.md) guidelines.
69
79
70
80
# Credits:
71
-
Development of PyCSEP is a group effort. A list of developers that have contributed to the PyCSEP Toolkit
72
-
are listed in the [Credits](CREDITS.md) file in this repository.
81
+
Development of pyCSEP is a group effort. A list of developers that have contributed to the PyCSEP Toolkit
82
+
are listed in the [credits](CREDITS.md) file in this repository.
73
83
74
84
# License:
75
-
The PyCSEP software is distributed under the BSD 3-Clause open-source license. Please see the [LICENSE.txt](LICENSE.txt) file for more information.
85
+
The pyCSEP software is distributed under the BSD 3-Clause open-source license. Please see the [license](LICENSE.txt) file for more information.
0 commit comments