floatcsep 0.3.0

CSEP Floating Experiment application

CSEP Floating Experiments

An application to deploy reproducible and prospective experiments of earthquake forecasting

• Set up a testing experiment for your earthquake forecasts using authoritative data sources and benchmarks.
• Encapsulate the complete experiment's definition and rules in a couple of lines.
• Reproduce, reuse, and share forecasting experiments from you, other researchers and institutions.

Table of Contents

• Installation
• Documentation
• Run and explore
• Useful Links
• Roadmap/Issues
• Contributing
• License

Installing floatCSEP

The core of floatCSEP is built around the pyCSEP package (https://github.com/sceccode/pycsep), which itself contains the core dependencies.

Stable Release

The simplest way to install floatCSEP is by creating a conda environment (https://conda.io - checkout Anaconda or Miniforge) and install floatCSEP from conda-forge

conda create -n $NAME -y
conda activate $NAME
conda install -c conda-forge floatcsep -y

Latest version

Clone and install the floatCSEP source code using pip

conda create -n $NAME -y
conda activate $NAME
git clone https://github.com/cseptesting/floatcsep
cd floatcsep
pip install .

Please read the Installation documentation for detailed instructions and additional installation methods.

Run an Experiment

Using the command terminal, navigate to an example experiment in floatcsep/tutorials/ and type

floatcsep run config.yml

A runtime directory will be created in a results folder. The experiment results can be visualized in results/report.md. Check out the experiment, models and tests definition in the tutorials!

Important Links

• Documentation
• CSEP Website
• pyCSEP Github
• pyCSEP Documentation

Roadmap and Known Issues

• Create tool to check a TD model's interface with floatcsep
• Define a dependency strategy to ensure experiments' reproducibility (e.g., storing docker image).
• Implement spatial database and HDF5 experiment storage feature
• Set up task parallelization
• Document the process of an experiment deployment

Contributing

We encourage all types of contributions, from reporting bugs, suggesting enhancements, adding new features and more. Please refer to the Contribution Guidelines and the Code of Conduct for more information

License

The floatCSEP (as well as pyCSEP) software is distributed under the BSD 3-Clause open-source license. Please see the license file for more information.

Support

This research was supported by the Statewide California Earthquake Center. SCEC is funded by NSF Cooperative Agreement EAR-2225216 and USGS Cooperative Agreement G24AC00072-00.	The work in this repository has received funding from the European Union’s Horizon research and innovation programme under grant agreements No.s 101058518 and 821115 of the projects GeoInquire and RISE.