Skip to content

Commit aa65b54

Browse files
committed
small modifications to README.md
* updated links to images * changed example snippet to include plotting * minor text changes
1 parent 3939290 commit aa65b54

File tree

1 file changed

+40
-30
lines changed

1 file changed

+40
-30
lines changed

README.md

Lines changed: 40 additions & 30 deletions
Original file line numberDiff line numberDiff line change
@@ -1,18 +1,18 @@
1-
# PyCSEP: Collaboratory for the Study of Earthquake Predictability
2-
![](https://g-c662a6.a78b8.36fe.data.globus.org/csep/badges/CSEP2_Logo_CMYK.png)
3-
![Python version](https://g-c662a6.a78b8.36fe.data.globus.org/csep/badges/pycsep-python.svg)
1+
# pyCSEP: Collaboratory for the Study of Earthquake Predictability
2+
![](https://i.postimg.cc/Bb60rVQP/CSEP2-Logo-CMYK.png)
3+
![Python version](https://gist.githubusercontent.com/wsavran/efce311162c32460336a4f9892218532/raw/1b9c060efd1c6e52eb53f82d4249107417d6a5ec/pycsep_python_badge.svg)
44
![Python application](https://github.com/SCECCode/csep2/workflows/Python%20application/badge.svg)
55
[![Build sphinx documentation](https://github.com/SCECCode/csep2/workflows/Build%20sphinx%20documentation/badge.svg)](https://cseptesting.org)
66
[![codecov](https://codecov.io/gh/SCECcode/pycsep/branch/master/graph/badge.svg?token=HTMKM29MAU)](https://codecov.io/gh/SCECcode/pycsep)
77

88
# Description:
9-
The PyCSEP Toolkit helps earthquake forecast model developers evaluate their forecasts with the goal of understanding
9+
The pyCSEP Toolkit helps earthquake forecast model developers evaluate their forecasts with the goal of understanding
1010
earthquake predictability.
1111

12-
PyCSEP should:
12+
pyCSEP should:
1313
1. Help modelers become familiar with formats, procedures, and evaluations used in CSEP Testing Centers.
1414
2. Provide vetted software for model developers to use in their research.
15-
3. Provide quantative and visual tools to assess earthquake forecast quality.
15+
3. Provide quantitative and visual tools to assess earthquake forecast quality.
1616
4. Promote open-science ideas by ensuring transparency and availability of scientific code and results.
1717
5. Curate benchmark models and data sets for modelers to conduct retrospective experiments of their forecasts.
1818

@@ -22,54 +22,64 @@ PyCSEP should:
2222
3. [Usage](#usage)
2323
4. [Contributing](#contributing)
2424
5. [Change Log](https://github.com/SCECcode/pycsep/blob/master/CHANGELOG.txt)
25-
6. [Credits](#credit)
25+
6. [Credits](#credits)
2626
7. [License](#license)
2727

2828
# Installation:
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.
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.
3232
These which may be installed automatically, or manually, depending on the installation method used.
3333
* 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/)
3740

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.
3946

4047
# 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:
4250
* Earthquake Catalogs
4351
* Earthquake Forecasts
4452
* Earthquake Forecast Evaluations
4553
* Regions
4654

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:
4856
<pre>
4957
import csep
5058
from csep.core import regions
51-
from csep.utils import time_utils, comcat
52-
start_time = csep.utils.time_utils.strptime_to_utc_datetime('2019-01-01 00:00:00.0')
53-
end_time = csep.utils.time_utils.utc_now_datetime()
59+
from csep.utils import time_utils
60+
start_time = time_utils.strptime_to_utc_datetime('2019-01-01 00:00:00.0')
61+
end_time = time_utils.utc_now_datetime()
5462
catalog = csep.query_comcat(start_time, end_time)
55-
print(catalog)
63+
catalog.plot()
5664
</pre>
5765

58-
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.
5967

6068
# 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.
62-
1. [UCVM Github Issue Tracker:](https://github.com/SCECcode/pycep/issues)
63-
2. Email Contact: software@scec.usc.edu
69+
Software support for pyCSEP is provided by that Southern California Earthquake Center (SCEC) Research Computing Group.
70+
This group supports several research software distributions including UCVM. Users can report issues and feature requests
71+
using the pyCSEP github-based issue tracking link below. Developers will also respond to emails sent to the SCEC software contact listed below.
72+
1. [pyCSEP Issues](https://github.com/SCECcode/pycep/issues)
73+
2. Email Contact: software [at] scec [dot] usc [dot] edu
6474

6575
# 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.
6979

7080
# 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.
7383

7484
# 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

Comments
 (0)