Get Started
Installation
Concepts
Tutorial Experiments
A - Testing a Simple Model
B - Multiple Models and Tests
C - Multiple Time Windows
D - Catalog and Model Queries
E - A Time-Independent Experiment
F - Testing Catalog-Based Forecasts
G - Testing a Time-Dependent Model
H - A Time-Dependent Experiment
I — Containerizing a Model with Docker
J — Running in Parallel a Real Model
Defining an Experiment
Experiment Configuration
Models Configuration
Evaluations Definition
Post-Process Options
Executing an Experiment
Help & Reference
GitHub
API Documentation
Getting Help
Contributing
License
floatCSEP
Index
Index
A
|
B
|
C
|
D
|
E
|
F
|
G
|
H
|
I
|
J
|
K
|
L
|
M
|
N
|
P
|
Q
|
R
|
S
|
T
|
V
|
W
|
X
A
add() (floatcsep.infrastructure.engine.TaskGraph method)
add_dependency() (floatcsep.infrastructure.engine.TaskGraph method)
add_figure() (floatcsep.postprocess.reporting.MarkdownReport method)
add_heading() (floatcsep.postprocess.reporting.MarkdownReport method)
add_introduction() (floatcsep.postprocess.reporting.MarkdownReport method)
add_list() (floatcsep.postprocess.reporting.MarkdownReport method)
add_model_registry() (floatcsep.infrastructure.registries.ExperimentFileRegistry method)
add_table() (floatcsep.postprocess.reporting.MarkdownReport method)
add_text() (floatcsep.postprocess.reporting.MarkdownReport method)
add_title() (floatcsep.postprocess.reporting.MarkdownReport method)
as_dict() (floatcsep.evaluation.Evaluation method)
(floatcsep.experiment.Experiment method)
(floatcsep.infrastructure.registries.ExperimentFileRegistry method)
(floatcsep.infrastructure.registries.ModelFileRegistry method)
(floatcsep.infrastructure.repositories.CatalogRepository method)
(floatcsep.model.Model method)
ascii() (floatcsep.utils.file_io.CatalogParser static method)
(floatcsep.utils.file_io.CatalogSerializer static method)
B
build_tree() (floatcsep.infrastructure.registries.ExperimentFileRegistry method)
(floatcsep.infrastructure.registries.ModelFileRegistry method)
C
catalog (floatcsep.infrastructure.repositories.CatalogRepository property)
CatalogForecastParsers (class in floatcsep.utils.file_io)
CatalogForecastRepository (class in floatcsep.infrastructure.repositories)
CatalogParser (class in floatcsep.utils.file_io)
CatalogRepository (class in floatcsep.infrastructure.repositories)
CatalogSerializer (class in floatcsep.utils.file_io)
check_environment_type() (floatcsep.infrastructure.environments.EnvironmentFactory static method)
check_format() (in module floatcsep.utils.file_io)
check_hash() (in module floatcsep.utils.accessors)
compute() (floatcsep.evaluation.Evaluation method)
CondaManager (class in floatcsep.infrastructure.environments)
create_environment() (floatcsep.infrastructure.environments.CondaManager method)
(floatcsep.infrastructure.environments.DockerManager method)
(floatcsep.infrastructure.environments.VenvManager method)
create_forecast() (floatcsep.model.Model method)
(floatcsep.model.TimeDependentModel method)
(floatcsep.model.TimeIndependentModel method)
csv() (floatcsep.utils.file_io.CatalogForecastParsers static method)
(floatcsep.utils.file_io.GriddedForecastParsers static method)
custom_report() (in module floatcsep.postprocess.reporting)
D
dat() (floatcsep.utils.file_io.GriddedForecastParsers static method)
detect_package_manager() (floatcsep.infrastructure.environments.CondaManager static method)
detect_python_version() (floatcsep.infrastructure.environments.CondaManager method)
DockerManager (class in floatcsep.infrastructure.environments)
download_file() (in module floatcsep.utils.accessors)
E
env_exists() (floatcsep.infrastructure.environments.CondaManager method)
(floatcsep.infrastructure.environments.DockerManager method)
(floatcsep.infrastructure.environments.VenvManager method)
EnvironmentFactory (class in floatcsep.infrastructure.environments)
Evaluation (class in floatcsep.evaluation)
Experiment (class in floatcsep.experiment)
ExperimentFileRegistry (class in floatcsep.infrastructure.registries)
F
factory() (floatcsep.model.Model class method)
filter_catalog() (floatcsep.infrastructure.repositories.CatalogRepository method)
floatcsep() (in module floatcsep.commands.main)
floatcsep.commands.main
module
floatcsep.postprocess.plot_handler
module
floatcsep.postprocess.reporting
module
floatcsep.utils.accessors
module
floatcsep.utils.file_io
module
floatcsep.utils.helpers
module
fmt (floatcsep.infrastructure.registries.ModelFileRegistry property)
forecast_exists() (floatcsep.infrastructure.registries.ModelFileRegistry method)
from_dict() (floatcsep.evaluation.Evaluation class method)
(floatcsep.model.Model class method)
from_git() (in module floatcsep.utils.accessors)
from_yml() (floatcsep.experiment.Experiment class method)
from_zenodo() (in module floatcsep.utils.accessors)
G
generate_report() (in module floatcsep.postprocess.reporting)
get_args_key() (floatcsep.infrastructure.registries.ModelFileRegistry method)
get_args_template_path() (floatcsep.infrastructure.registries.ModelFileRegistry method)
get_attr() (floatcsep.infrastructure.registries.ExperimentFileRegistry method)
get_catalog() (floatcsep.evaluation.Evaluation method)
get_env() (floatcsep.infrastructure.environments.EnvironmentFactory static method)
get_figure_key() (floatcsep.infrastructure.registries.ExperimentFileRegistry method)
get_forecast() (floatcsep.model.Model method)
(floatcsep.model.TimeDependentModel method)
(floatcsep.model.TimeIndependentModel method)
get_forecast_dir() (floatcsep.infrastructure.registries.ModelFileRegistry method)
get_forecast_key() (floatcsep.infrastructure.registries.ModelFileRegistry method)
get_image_aspect() (in module floatcsep.postprocess.reporting)
get_input_catalog_key() (floatcsep.infrastructure.registries.ModelFileRegistry method)
get_input_dir() (floatcsep.infrastructure.registries.ModelFileRegistry method)
get_model() (floatcsep.experiment.Experiment method)
get_model_registry() (floatcsep.infrastructure.registries.ExperimentFileRegistry method)
get_result_key() (floatcsep.infrastructure.registries.ExperimentFileRegistry method)
get_source() (floatcsep.model.Model method)
(floatcsep.model.TimeDependentModel method)
(floatcsep.model.TimeIndependentModel method)
get_test() (floatcsep.experiment.Experiment method)
get_test_cat() (floatcsep.infrastructure.repositories.CatalogRepository method)
get_test_catalog_key() (floatcsep.infrastructure.registries.ExperimentFileRegistry method)
grid2hdf5() (floatcsep.utils.file_io.HDF5Serializer static method)
GriddedForecastParsers (class in floatcsep.utils.file_io)
GriddedForecastRepository (class in floatcsep.infrastructure.repositories)
H
hdf5() (floatcsep.utils.file_io.GriddedForecastParsers static method)
HDF5Serializer (class in floatcsep.utils.file_io)
I
install_dependencies() (floatcsep.infrastructure.environments.CondaManager method)
(floatcsep.infrastructure.environments.DockerManager method)
(floatcsep.infrastructure.environments.VenvManager method)
J
json() (floatcsep.utils.file_io.CatalogParser static method)
(floatcsep.utils.file_io.CatalogSerializer static method)
K
kill_containers() (floatcsep.infrastructure.environments.DockerManager static method)
L
load_forecast() (floatcsep.infrastructure.repositories.CatalogForecastRepository method)
(floatcsep.infrastructure.repositories.GriddedForecastRepository method)
load_hermes_catalog() (floatcsep.utils.file_io.CatalogForecastParsers static method)
load_results() (floatcsep.infrastructure.repositories.ResultsRepository method)
log (in module floatcsep.postprocess.reporting)
M
magnitude_vs_time() (in module floatcsep.utils.helpers)
make_repr() (floatcsep.experiment.Experiment method)
markdown_to_pdf() (in module floatcsep.postprocess.reporting)
MarkdownReport (class in floatcsep.postprocess.reporting)
Model (class in floatcsep.model)
ModelFileRegistry (class in floatcsep.infrastructure.registries)
module
floatcsep.commands.main
floatcsep.postprocess.plot_handler
floatcsep.postprocess.reporting
floatcsep.utils.accessors
floatcsep.utils.file_io
floatcsep.utils.helpers
N
ntasks (floatcsep.infrastructure.engine.TaskGraph property)
P
parse_csep_func() (in module floatcsep.utils.helpers)
parse_nested_dicts() (in module floatcsep.utils.helpers)
parse_plot_config() (in module floatcsep.postprocess.plot_handler)
parse_plots() (floatcsep.evaluation.Evaluation method)
parse_projection() (in module floatcsep.postprocess.plot_handler)
parse_timedelta_string() (in module floatcsep.utils.helpers)
plot() (in module floatcsep.commands.main)
plot_catalogs() (in module floatcsep.postprocess.plot_handler)
plot_custom() (in module floatcsep.postprocess.plot_handler)
plot_forecasts() (in module floatcsep.postprocess.plot_handler)
plot_matrix_comparative_test() (in module floatcsep.utils.helpers)
plot_results() (in module floatcsep.postprocess.plot_handler)
plot_sequential_likelihood() (in module floatcsep.utils.helpers)
prepare_args() (floatcsep.evaluation.Evaluation method)
(floatcsep.model.TimeDependentModel method)
prepare_extra_input() (floatcsep.model.TimeDependentModel method)
Q
quadtree() (floatcsep.utils.file_io.GriddedForecastParsers static method)
R
read_region_cfg() (in module floatcsep.utils.helpers)
read_results() (floatcsep.evaluation.Evaluation method)
(floatcsep.experiment.Experiment method)
read_time_cfg() (in module floatcsep.utils.helpers)
remove() (floatcsep.infrastructure.repositories.CatalogForecastRepository method)
(floatcsep.infrastructure.repositories.GriddedForecastRepository method)
reproduce() (in module floatcsep.commands.main)
reproducibility_report() (in module floatcsep.postprocess.reporting)
result_exist() (floatcsep.infrastructure.registries.ExperimentFileRegistry method)
ResultsRepository (class in floatcsep.infrastructure.repositories)
run() (floatcsep.experiment.Experiment method)
(floatcsep.infrastructure.engine.Task method)
(floatcsep.infrastructure.engine.TaskGraph method)
(in module floatcsep.commands.main)
run_command() (floatcsep.infrastructure.environments.CondaManager method)
(floatcsep.infrastructure.environments.DockerManager method)
(floatcsep.infrastructure.environments.VenvManager method)
run_parallel() (floatcsep.infrastructure.engine.TaskGraph method)
S
save() (floatcsep.postprocess.reporting.MarkdownReport method)
sequential_information_gain() (in module floatcsep.utils.helpers)
sequential_likelihood() (in module floatcsep.utils.helpers)
serialize() (in module floatcsep.utils.file_io)
set_input_cats() (floatcsep.infrastructure.repositories.CatalogRepository method)
set_main_catalog() (floatcsep.infrastructure.repositories.CatalogRepository method)
set_models() (floatcsep.experiment.Experiment method)
set_tasks() (floatcsep.experiment.Experiment method)
set_test_cats() (floatcsep.infrastructure.repositories.CatalogRepository method)
set_tests() (floatcsep.experiment.Experiment method)
set_tree() (floatcsep.experiment.Experiment method)
sign_match() (floatcsep.infrastructure.engine.Task method)
stage() (floatcsep.model.Model method)
(floatcsep.model.TimeDependentModel method)
(floatcsep.model.TimeIndependentModel method)
(in module floatcsep.commands.main)
stage_models() (floatcsep.experiment.Experiment method)
str2timewindow() (in module floatcsep.utils.helpers)
T
table_of_contents() (floatcsep.postprocess.reporting.MarkdownReport method)
Task (class in floatcsep.infrastructure.engine)
TaskGraph (class in floatcsep.infrastructure.engine)
time_windows_td() (in module floatcsep.utils.helpers)
time_windows_ti() (in module floatcsep.utils.helpers)
TimeDependentModel (class in floatcsep.model)
TimeIndependentModel (class in floatcsep.model)
timewindow2str() (in module floatcsep.utils.helpers)
to_markdown() (floatcsep.postprocess.reporting.MarkdownReport method)
to_yml() (floatcsep.experiment.Experiment method)
type (floatcsep.evaluation.Evaluation property)
V
vector_poisson_t_w_test() (in module floatcsep.utils.helpers)
VenvManager (class in floatcsep.infrastructure.environments)
view() (in module floatcsep.commands.main)
W
width_fraction_from_aspect() (in module floatcsep.postprocess.reporting)
write_result() (floatcsep.infrastructure.repositories.ResultsRepository method)
X
xml() (floatcsep.utils.file_io.GriddedForecastParsers static method)