bout_runners
latest
About BOUT Runners
Contents
Introduction
Contributing to BOUT Runners
License
User guide
Project structure
Runner
The run graph
Submitters
Metadata
What's new
What’s New in BOUT Runners
API documentation
API Documentation
bout_runners
Docs
»
Index
Edit on GitHub
Index
A
|
B
|
C
|
D
|
E
|
F
|
G
|
H
|
I
|
J
|
K
|
L
|
M
|
N
|
P
|
Q
|
R
|
S
|
T
|
U
|
V
|
W
A
AbstractClusterSubmitter (class in bout_runners.submitter.abstract_cluster_submitter)
AbstractSubmitter (class in bout_runners.submitter.abstract_submitter)
add_bout_run_node() (bout_runners.runner.run_graph.RunGraph method)
add_edge() (bout_runners.runner.run_graph.RunGraph method)
add_function_node() (bout_runners.runner.run_graph.RunGraph method)
add_post_processor() (bout_runners.runner.run_group.RunGroup method)
add_pre_processor() (bout_runners.runner.run_group.RunGroup method)
add_waiting_for() (bout_runners.runner.run_graph.RunGraph method)
(bout_runners.submitter.abstract_cluster_submitter.AbstractClusterSubmitter method)
(bout_runners.submitter.pbs_submitter.PBSSubmitter method)
(bout_runners.submitter.slurm_submitter.SLURMSubmitter method)
B
bout_inp_dst_dir() (bout_runners.parameters.bout_paths.BoutPaths property)
bout_inp_src_dir() (bout_runners.parameters.bout_paths.BoutPaths property)
bout_paths() (bout_runners.parameters.bout_run_setup.BoutRunSetup property)
(bout_runners.runner.bout_run_executor.BoutRunExecutor property)
(bout_runners.runner.run_group.RunGroup property)
bout_run_node_name() (bout_runners.runner.run_group.RunGroup property)
bout_runners
module
bout_runners.config
module
bout_runners.configure_bout_runners
module
bout_runners.database
module
bout_runners.database.database_connector
module
bout_runners.database.database_creator
module
bout_runners.database.database_reader
module
bout_runners.database.database_utils
module
bout_runners.database.database_writer
module
bout_runners.log
module
bout_runners.log.log_reader
module
bout_runners.make
module
bout_runners.make.make
module
bout_runners.make.read_makefile
module
bout_runners.metadata
module
bout_runners.metadata.metadata_reader
module
bout_runners.metadata.metadata_recorder
module
bout_runners.metadata.metadata_updater
module
bout_runners.metadata.status_checker
module
bout_runners.parameters
module
bout_runners.parameters.bout_paths
module
bout_runners.parameters.bout_run_setup
module
bout_runners.parameters.default_parameters
module
bout_runners.parameters.final_parameters
module
bout_runners.parameters.run_parameters
module
bout_runners.runner
module
bout_runners.runner.bout_run_executor
module
bout_runners.runner.bout_runner
module
bout_runners.runner.run_graph
module
bout_runners.runner.run_group
module
bout_runners.submitter
module
bout_runners.submitter.abstract_cluster_submitter
module
bout_runners.submitter.abstract_submitter
module
bout_runners.submitter.local_submitter
module
bout_runners.submitter.pbs_submitter
module
bout_runners.submitter.processor_split
module
bout_runners.submitter.slurm_submitter
module
bout_runners.submitter.submitter_factory
module
bout_runners.utils
module
bout_runners.utils.file_operations
module
bout_runners.utils.logs
module
bout_runners.utils.names
module
bout_runners.utils.paths
module
bout_runners.utils.serializers
module
BoutMakefileReader (class in bout_runners.make.read_makefile)
BoutMakefileVariableReader (class in bout_runners.make.read_makefile)
BoutPaths (class in bout_runners.parameters.bout_paths)
BoutRunExecutor (class in bout_runners.runner.bout_run_executor)
BoutRunner (class in bout_runners.runner.bout_runner)
BoutRunSetup (class in bout_runners.parameters.bout_run_setup)
C
capture_new_data_from_run() (bout_runners.metadata.metadata_recorder.MetadataRecorder method)
cast_to_sql_type() (bout_runners.parameters.final_parameters.FinalParameters static method)
change_status_node_and_dependencies() (bout_runners.runner.run_graph.RunGraph method)
check_and_update_status() (bout_runners.metadata.status_checker.StatusChecker method)
check_and_update_until_complete() (bout_runners.metadata.status_checker.StatusChecker method)
check_if_running_or_errored() (bout_runners.metadata.status_checker.StatusChecker static method)
check_submitter_config() (in module bout_runners.configure_bout_runners)
check_tables_created() (bout_runners.database.database_reader.DatabaseReader method)
cluster_node_exist() (bout_runners.runner.bout_runner.BoutRunner method)
completed() (bout_runners.submitter.abstract_cluster_submitter.AbstractClusterSubmitter method)
(bout_runners.submitter.abstract_submitter.AbstractSubmitter method)
(bout_runners.submitter.local_submitter.LocalSubmitter method)
(bout_runners.submitter.pbs_submitter.PBSSubmitter method)
(bout_runners.submitter.slurm_submitter.SLURMSubmitter method)
connection() (bout_runners.database.database_connector.DatabaseConnector property)
converter() (bout_runners.utils.logs.IndentFormatter method)
copy_restart_files() (in module bout_runners.utils.file_operations)
create_all_schema_tables() (bout_runners.database.database_creator.DatabaseCreator method)
create_db_path() (bout_runners.database.database_connector.DatabaseConnector static method)
create_entry() (bout_runners.database.database_writer.DatabaseWriter method)
(bout_runners.metadata.metadata_recorder.MetadataRecorder method)
create_insert_string() (bout_runners.database.database_writer.DatabaseWriter static method)
create_submission_string() (bout_runners.submitter.abstract_cluster_submitter.AbstractClusterSubmitter method)
(bout_runners.submitter.pbs_submitter.PBSSubmitter method)
(bout_runners.submitter.slurm_submitter.SLURMSubmitter method)
create_update_string() (bout_runners.database.database_writer.DatabaseWriter static method)
D
DatabaseConnector (class in bout_runners.database.database_connector)
DatabaseCreator (class in bout_runners.database.database_creator)
DatabaseReader (class in bout_runners.database.database_reader)
DatabaseWriter (class in bout_runners.database.database_writer)
db_connector() (bout_runners.parameters.bout_run_setup.BoutRunSetup property)
(bout_runners.runner.run_group.RunGroup property)
db_path() (bout_runners.database.database_connector.DatabaseConnector property)
db_reader() (bout_runners.metadata.metadata_recorder.MetadataRecorder property)
db_writer() (bout_runners.metadata.metadata_recorder.MetadataRecorder property)
DefaultParameters (class in bout_runners.parameters.default_parameters)
drop_ids() (in module bout_runners.metadata.metadata_reader)
E
end_time() (bout_runners.log.log_reader.LogReader property)
ended() (bout_runners.log.log_reader.LogReader method)
errored() (bout_runners.submitter.abstract_cluster_submitter.AbstractClusterSubmitter method)
(bout_runners.submitter.abstract_submitter.AbstractSubmitter method)
(bout_runners.submitter.local_submitter.LocalSubmitter method)
(bout_runners.submitter.pbs_submitter.PBSSubmitter method)
(bout_runners.submitter.slurm_submitter.SLURMSubmitter method)
exec_name() (bout_runners.runner.bout_run_executor.BoutRunExecutor property)
execute() (bout_runners.runner.bout_run_executor.BoutRunExecutor method)
execute_statement() (bout_runners.database.database_connector.DatabaseConnector method)
executor() (bout_runners.parameters.bout_run_setup.BoutRunSetup property)
extract_job_id() (bout_runners.submitter.abstract_cluster_submitter.AbstractClusterSubmitter static method)
(bout_runners.submitter.pbs_submitter.PBSSubmitter static method)
(bout_runners.submitter.slurm_submitter.SLURMSubmitter static method)
F
final_parameters() (bout_runners.parameters.bout_run_setup.BoutRunSetup property)
FinalParameters (class in bout_runners.parameters.final_parameters)
find_matching_order_number() (bout_runners.runner.bout_runner.BoutRunner static method)
format() (bout_runners.utils.logs.IndentFormatter method)
formatException() (bout_runners.utils.logs.IndentFormatter method)
formatStack() (bout_runners.utils.logs.IndentFormatter method)
formatTime() (bout_runners.utils.logs.IndentFormatter method)
G
get_all_metadata() (bout_runners.metadata.metadata_reader.MetadataReader method)
get_bout_directory() (in module bout_runners.utils.paths)
get_bout_runners_config_path() (in module bout_runners.utils.paths)
get_bout_runners_configuration() (in module bout_runners.utils.paths)
get_bout_runners_package_path() (in module bout_runners.utils.paths)
get_caller_dir() (in module bout_runners.utils.file_operations)
get_config_path() (in module bout_runners.utils.paths)
get_create_table_statement() (bout_runners.database.database_creator.DatabaseCreator static method)
get_days_hours_minutes_seconds_from_str() (bout_runners.submitter.abstract_cluster_submitter.AbstractClusterSubmitter static method)
(bout_runners.submitter.pbs_submitter.PBSSubmitter static method)
(bout_runners.submitter.slurm_submitter.SLURMSubmitter static method)
get_default_parameters() (bout_runners.parameters.default_parameters.DefaultParameters method)
get_default_submitters_config_path() (in module bout_runners.utils.paths)
get_dot_string() (bout_runners.runner.run_graph.RunGraph method)
get_entry_id() (bout_runners.database.database_reader.DatabaseReader method)
get_exec_name() (in module bout_runners.utils.names)
get_execute_command() (bout_runners.runner.bout_run_executor.BoutRunExecutor method)
get_file_modification() (in module bout_runners.database.database_utils)
get_final_parameters() (bout_runners.parameters.final_parameters.FinalParameters method)
get_git_sha() (in module bout_runners.database.database_utils)
get_join_query() (bout_runners.metadata.metadata_reader.MetadataReader static method)
get_latest_row_id() (bout_runners.database.database_reader.DatabaseReader method)
get_log_config() (in module bout_runners.utils.logs)
get_log_file_directory() (in module bout_runners.utils.paths)
get_log_file_path() (in module bout_runners.utils.paths)
get_logger_config_path() (in module bout_runners.utils.paths)
get_makefile_name() (in module bout_runners.utils.names)
get_makefile_path() (in module bout_runners.utils.names)
get_modified_time() (in module bout_runners.utils.file_operations)
get_node_orders() (bout_runners.runner.run_graph.RunGraph method)
get_parameters_metadata() (bout_runners.metadata.metadata_reader.MetadataReader method)
get_processor_split() (in module bout_runners.submitter.submitter_factory)
get_query_string_for_non_errored_runs() (bout_runners.metadata.status_checker.StatusChecker static method)
get_return_code() (bout_runners.submitter.pbs_submitter.PBSSubmitter static method)
(bout_runners.submitter.slurm_submitter.SLURMSubmitter static method)
get_sacct() (bout_runners.submitter.slurm_submitter.SLURMSubmitter method)
get_simulation_steps() (bout_runners.log.log_reader.LogReader method)
get_state() (bout_runners.submitter.slurm_submitter.SLURMSubmitter static method)
get_submission_dict() (in module bout_runners.submitter.submitter_factory)
get_submitter() (in module bout_runners.submitter.submitter_factory)
get_submitters_config_path() (in module bout_runners.utils.paths)
get_submitters_configuration() (in module bout_runners.utils.paths)
get_system_info() (in module bout_runners.database.database_utils)
get_system_info_as_sql_type() (in module bout_runners.database.database_utils)
get_test_executor() (bout_runners.parameters.default_parameters.DefaultParameters static method)
get_trace() (bout_runners.submitter.pbs_submitter.PBSSubmitter method)
get_waiting_for_tuple() (bout_runners.runner.run_graph.RunGraph method)
H
has_dequeue() (bout_runners.submitter.pbs_submitter.PBSSubmitter static method)
I
IndentFormatter (class in bout_runners.utils.logs)
infer_submitter() (in module bout_runners.submitter.submitter_factory)
insert() (bout_runners.database.database_writer.DatabaseWriter method)
is_jsonable() (in module bout_runners.utils.serializers)
J
job_id() (bout_runners.submitter.abstract_cluster_submitter.AbstractClusterSubmitter property)
(bout_runners.submitter.abstract_submitter.AbstractSubmitter property)
(bout_runners.submitter.local_submitter.LocalSubmitter property)
(bout_runners.submitter.pbs_submitter.PBSSubmitter property)
(bout_runners.submitter.slurm_submitter.SLURMSubmitter property)
job_name() (bout_runners.submitter.abstract_cluster_submitter.AbstractClusterSubmitter property)
(bout_runners.submitter.pbs_submitter.PBSSubmitter property)
(bout_runners.submitter.slurm_submitter.SLURMSubmitter property)
K
kill() (bout_runners.submitter.abstract_cluster_submitter.AbstractClusterSubmitter method)
(bout_runners.submitter.pbs_submitter.PBSSubmitter method)
(bout_runners.submitter.slurm_submitter.SLURMSubmitter method)
L
LocalSubmitter (class in bout_runners.submitter.local_submitter)
LogReader (class in bout_runners.log.log_reader)
M
Make (class in bout_runners.make.make)
MakeError
MakefileReaderError
metadata_recorder() (bout_runners.parameters.bout_run_setup.BoutRunSetup property)
MetadataReader (class in bout_runners.metadata.metadata_reader)
MetadataRecorder (class in bout_runners.metadata.metadata_recorder)
MetadataUpdater (class in bout_runners.metadata.metadata_updater)
module
bout_runners
bout_runners.config
bout_runners.configure_bout_runners
bout_runners.database
bout_runners.database.database_connector
bout_runners.database.database_creator
bout_runners.database.database_reader
bout_runners.database.database_utils
bout_runners.database.database_writer
bout_runners.log
bout_runners.log.log_reader
bout_runners.make
bout_runners.make.make
bout_runners.make.read_makefile
bout_runners.metadata
bout_runners.metadata.metadata_reader
bout_runners.metadata.metadata_recorder
bout_runners.metadata.metadata_updater
bout_runners.metadata.status_checker
bout_runners.parameters
bout_runners.parameters.bout_paths
bout_runners.parameters.bout_run_setup
bout_runners.parameters.default_parameters
bout_runners.parameters.final_parameters
bout_runners.parameters.run_parameters
bout_runners.runner
bout_runners.runner.bout_run_executor
bout_runners.runner.bout_runner
bout_runners.runner.run_graph
bout_runners.runner.run_group
bout_runners.submitter
bout_runners.submitter.abstract_cluster_submitter
bout_runners.submitter.abstract_submitter
bout_runners.submitter.local_submitter
bout_runners.submitter.pbs_submitter
bout_runners.submitter.processor_split
bout_runners.submitter.slurm_submitter
bout_runners.submitter.submitter_factory
bout_runners.utils
bout_runners.utils.file_operations
bout_runners.utils.logs
bout_runners.utils.names
bout_runners.utils.paths
bout_runners.utils.serializers
N
nodes() (bout_runners.runner.run_graph.RunGraph property)
number_of_nodes() (bout_runners.submitter.processor_split.ProcessorSplit property)
number_of_processors() (bout_runners.submitter.processor_split.ProcessorSplit property)
P
pbs_is_available() (in module bout_runners.submitter.submitter_factory)
PBSSubmitter (class in bout_runners.submitter.pbs_submitter)
pid() (bout_runners.log.log_reader.LogReader property)
pid_exist() (bout_runners.log.log_reader.LogReader method)
post_processors() (bout_runners.runner.run_group.RunGroup property)
pre_processors() (bout_runners.runner.run_group.RunGroup property)
predecessors() (bout_runners.runner.run_graph.RunGraph method)
processors_per_node() (bout_runners.submitter.processor_split.ProcessorSplit property)
ProcessorSplit (class in bout_runners.submitter.processor_split)
project_path() (bout_runners.parameters.bout_paths.BoutPaths property)
Q
query() (bout_runners.database.database_reader.DatabaseReader method)
R
raise_error() (bout_runners.submitter.abstract_cluster_submitter.AbstractClusterSubmitter method)
(bout_runners.submitter.abstract_submitter.AbstractSubmitter method)
(bout_runners.submitter.local_submitter.LocalSubmitter method)
(bout_runners.submitter.pbs_submitter.PBSSubmitter method)
(bout_runners.submitter.slurm_submitter.SLURMSubmitter method)
read() (bout_runners.make.read_makefile.BoutMakefileReader method)
(bout_runners.make.read_makefile.BoutMakefileVariableReader method)
release() (bout_runners.submitter.abstract_cluster_submitter.AbstractClusterSubmitter method)
(bout_runners.submitter.pbs_submitter.PBSSubmitter method)
(bout_runners.submitter.slurm_submitter.SLURMSubmitter method)
release_nodes() (bout_runners.runner.bout_runner.BoutRunner method)
released() (bout_runners.submitter.abstract_cluster_submitter.AbstractClusterSubmitter property)
(bout_runners.submitter.pbs_submitter.PBSSubmitter property)
(bout_runners.submitter.slurm_submitter.SLURMSubmitter property)
remove_edge() (bout_runners.runner.run_graph.RunGraph method)
reset() (bout_runners.runner.bout_runner.BoutRunner method)
(bout_runners.runner.run_graph.RunGraph method)
(bout_runners.submitter.abstract_cluster_submitter.AbstractClusterSubmitter method)
(bout_runners.submitter.abstract_submitter.AbstractSubmitter method)
(bout_runners.submitter.local_submitter.LocalSubmitter method)
(bout_runners.submitter.pbs_submitter.PBSSubmitter method)
(bout_runners.submitter.slurm_submitter.SLURMSubmitter method)
restart_from() (bout_runners.runner.bout_run_executor.BoutRunExecutor property)
return_code() (bout_runners.submitter.abstract_cluster_submitter.AbstractClusterSubmitter property)
(bout_runners.submitter.abstract_submitter.AbstractSubmitter property)
(bout_runners.submitter.local_submitter.LocalSubmitter property)
(bout_runners.submitter.pbs_submitter.PBSSubmitter property)
(bout_runners.submitter.slurm_submitter.SLURMSubmitter property)
run() (bout_runners.runner.bout_runner.BoutRunner method)
run_bout_run() (bout_runners.runner.bout_runner.BoutRunner static method)
run_clean() (bout_runners.make.make.Make method)
run_function() (bout_runners.runner.bout_runner.BoutRunner static method)
run_graph() (bout_runners.runner.bout_runner.BoutRunner property)
(bout_runners.runner.run_group.RunGroup property)
run_make() (bout_runners.make.make.Make method)
run_parameters() (bout_runners.runner.bout_run_executor.BoutRunExecutor property)
run_parameters_dict() (bout_runners.parameters.run_parameters.RunParameters property)
run_parameters_run() (bout_runners.parameters.default_parameters.DefaultParameters method)
run_parameters_str() (bout_runners.parameters.run_parameters.RunParameters property)
RunGraph (class in bout_runners.runner.run_graph)
RunGroup (class in bout_runners.runner.run_group)
RunParameters (class in bout_runners.parameters.run_parameters)
S
set_bout_directory() (in module bout_runners.configure_bout_runners)
set_log_file_directory() (in module bout_runners.configure_bout_runners)
set_log_level() (in module bout_runners.configure_bout_runners)
set_submitter_config_path() (in module bout_runners.configure_bout_runners)
set_up_logger() (in module bout_runners.utils.logs)
slurm_is_available() (in module bout_runners.submitter.submitter_factory)
SLURMSubmitter (class in bout_runners.submitter.slurm_submitter)
sorted_columns() (bout_runners.metadata.metadata_reader.MetadataReader property)
start_time() (bout_runners.log.log_reader.LogReader property)
started() (bout_runners.log.log_reader.LogReader method)
StatusChecker (class in bout_runners.metadata.status_checker)
std_err() (bout_runners.submitter.abstract_cluster_submitter.AbstractClusterSubmitter property)
(bout_runners.submitter.abstract_submitter.AbstractSubmitter property)
(bout_runners.submitter.local_submitter.LocalSubmitter property)
(bout_runners.submitter.pbs_submitter.PBSSubmitter property)
(bout_runners.submitter.slurm_submitter.SLURMSubmitter property)
std_out() (bout_runners.submitter.abstract_cluster_submitter.AbstractClusterSubmitter property)
(bout_runners.submitter.abstract_submitter.AbstractSubmitter property)
(bout_runners.submitter.local_submitter.LocalSubmitter property)
(bout_runners.submitter.pbs_submitter.PBSSubmitter property)
(bout_runners.submitter.slurm_submitter.SLURMSubmitter property)
store_dir() (bout_runners.submitter.abstract_cluster_submitter.AbstractClusterSubmitter property)
(bout_runners.submitter.pbs_submitter.PBSSubmitter property)
(bout_runners.submitter.slurm_submitter.SLURMSubmitter property)
structure_time_to_pbs_format() (bout_runners.submitter.pbs_submitter.PBSSubmitter static method)
structure_time_to_slurm_format() (bout_runners.submitter.slurm_submitter.SLURMSubmitter static method)
submit_command() (bout_runners.submitter.abstract_cluster_submitter.AbstractClusterSubmitter method)
(bout_runners.submitter.abstract_submitter.AbstractSubmitter method)
(bout_runners.submitter.local_submitter.LocalSubmitter method)
(bout_runners.submitter.pbs_submitter.PBSSubmitter method)
(bout_runners.submitter.slurm_submitter.SLURMSubmitter method)
submitter() (bout_runners.parameters.bout_run_setup.BoutRunSetup property)
successors() (bout_runners.runner.run_graph.RunGraph method)
T
table_column_dict() (bout_runners.metadata.metadata_reader.MetadataReader property)
table_connection() (bout_runners.metadata.metadata_reader.MetadataReader property)
table_names() (bout_runners.metadata.metadata_reader.MetadataReader property)
U
update() (bout_runners.database.database_writer.DatabaseWriter method)
update_field() (bout_runners.metadata.metadata_updater.MetadataUpdater method)
update_latest_status() (bout_runners.metadata.metadata_updater.MetadataUpdater method)
update_start_time() (bout_runners.metadata.metadata_updater.MetadataUpdater method)
update_stop_time() (bout_runners.metadata.metadata_updater.MetadataUpdater method)
usesTime() (bout_runners.utils.logs.IndentFormatter method)
V
value() (bout_runners.make.read_makefile.BoutMakefileReader property)
(bout_runners.make.read_makefile.BoutMakefileVariableReader property)
W
wait_until_completed() (bout_runners.runner.bout_runner.BoutRunner method)
(bout_runners.submitter.abstract_cluster_submitter.AbstractClusterSubmitter method)
(bout_runners.submitter.abstract_submitter.AbstractSubmitter method)
(bout_runners.submitter.local_submitter.LocalSubmitter method)
(bout_runners.submitter.pbs_submitter.PBSSubmitter method)
(bout_runners.submitter.slurm_submitter.SLURMSubmitter method)
waiting_for() (bout_runners.submitter.abstract_cluster_submitter.AbstractClusterSubmitter property)
(bout_runners.submitter.pbs_submitter.PBSSubmitter property)
(bout_runners.submitter.slurm_submitter.SLURMSubmitter property)
with_traceback() (bout_runners.make.make.MakeError method)
(bout_runners.make.read_makefile.MakefileReaderError method)
write_python_script() (bout_runners.submitter.abstract_cluster_submitter.AbstractClusterSubmitter static method)
(bout_runners.submitter.abstract_submitter.AbstractSubmitter static method)
(bout_runners.submitter.local_submitter.LocalSubmitter static method)
(bout_runners.submitter.pbs_submitter.PBSSubmitter static method)
(bout_runners.submitter.slurm_submitter.SLURMSubmitter static method)
Read the Docs
v: latest
Versions
master
latest
76_fix_readme
Downloads
On Read the Docs
Project Home
Builds
Free document hosting provided by
Read the Docs
.