API Documentation
Commands
The main entrypoint functions from the Command Line Interface are:
Experiment
The Experiment class is the main handler of floatCSEP, which
orchestrates the Model and Evaluation
instances onto an experimental workflow. The class and its main methods are:
Model
The Model class is the handler of forecasts creation, storage and
reading. The abstract and concrete classes, and their main methods are:
Evaluations
The Evaluation class is a wrapper for pycsep functions,
encapsulating the multiple function, arguments, forecast and catalogs of the entire experiment.
The class and main methods are:
Accessors
These are functions that access a model source from a web repository.
Helper Functions
These are the helper functions of floatCSEP
Some additional plotting functions to pyCSEP are:
Readers
A small wrapper for pyCSEP readers
Environments
The computational environment managers for floatcsep.
Registries
The registries hold references to the access points (e.g., filepaths) of the experiment components (e.g., forecasts, catalogs, results, etc.), and allows to be aware of their status.
Repositories
The repositories here are designed to store and access the experiment artifacts (results, catalogs, forecasts), abstracting the experiment logic from the pyCSEP io functionality.
Engine
The engine routines are designed for the execution of an experiment.