6.43
Contents:
Introduction
Get ESM-Tools
Before you continue
Ten Steps to a Running Model
Installation
ESM Tools
YAML File Syntax
Templating files with Jinja
YAML File Hierarchy
ESM-Tools Variables
ESM Master
ESM-Versions (deprecated)
ESM Runscripts
ESM Runscripts - Using the Workflow Manager
ESM Environment
ESM-Tests
ESM MOTD
Cookbook
Frequently Asked Questions
Python Packages
ESM Tools Code Documentation
Supported Models
Transitioning from the Shell Version
Contributing
How to cite the software
Credits
ESM Tools
Index
Index
_
|
A
|
B
|
C
|
D
|
E
|
F
|
G
|
H
|
I
|
K
|
L
|
M
|
N
|
O
|
P
|
Q
|
R
|
S
|
T
|
U
|
W
|
Y
_
_calendar (esm_calendar.esm_calendar.Date attribute)
A
action (esm_master.database.installation attribute)
actual vs check test
add() (esm_calendar.esm_calendar.Date method)
add_eol_comments_with_provenance() (in module esm_parser.dict_to_yaml)
add_modified_by() (esm_parser.provenance.Provenance method)
add_size_information() (in module esm_cleanup.esm_cleanup)
append_last_step_modified_by() (esm_parser.provenance.Provenance method)
archive_mistral() (in module esm_archiving)
(in module esm_archiving.esm_archiving)
ask_column() (esm_database.esm_database.DisplayDatabase method)
ask_dataset() (esm_database.esm_database.DisplayDatabase method)
ask_for_action() (in module esm_cleanup.esm_cleanup)
assert_question() (in module esm_cleanup.esm_cleanup)
B
BoolWithProvenance (class in esm_parser.provenance)
C
Calendar (class in esm_calendar.esm_calendar)
caller_wrapper() (in module esm_tools)
check_if_folder_exists() (in module esm_cleanup.esm_cleanup)
check_tar_lists() (in module esm_archiving)
(in module esm_archiving.esm_archiving)
check_valid_version() (in module esm_utilities.utils)
class_in (esm_database.location_database.database_location attribute)
clean_provenance() (in module esm_parser.provenance)
close() (esm_archiving.external.pypftp.Pftp method)
complete_targets() (esm_master.software_package.software_package method)
copy_config_folder() (in module esm_tools)
copy_namelist_folder() (in module esm_tools)
copy_runscript_folder() (in module esm_tools)
cwd() (esm_archiving.external.pypftp.Pftp method)
D
database_entry() (in module esm_master.database_actions)
database_location (class in esm_database.location_database)
Date (class in esm_calendar.esm_calendar)
date_range() (in module esm_calendar.esm_calendar)
Dateformat (class in esm_calendar.esm_calendar)
datesep (esm_calendar.esm_calendar.Dateformat attribute)
DatestampLocationError
day (esm_calendar.esm_calendar.Date attribute)
day_in_month() (esm_calendar.esm_calendar.Calendar method)
,
[1]
day_in_year() (esm_calendar.esm_calendar.Calendar method)
,
[1]
day_of_year() (esm_calendar.esm_calendar.Date method)
decision_maker() (esm_database.esm_database.DisplayDatabase method)
delete_original_data() (in module esm_archiving)
(in module esm_archiving.esm_archiving)
delete_prev_objects() (in module esm_parser.dict_to_yaml)
determine_datestamp_location() (in module esm_archiving)
(in module esm_archiving.esm_archiving)
determine_potential_datestamp_locations() (in module esm_archiving)
(in module esm_archiving.esm_archiving)
DictWithProvenance (class in esm_parser.provenance)
dir_size() (in module esm_cleanup.esm_cleanup)
directories() (esm_archiving.external.pypftp.Pftp method)
DisplayDatabase (class in esm_database.esm_database)
download() (esm_archiving.external.pypftp.Pftp static method)
(in module esm_archiving.external.pypftp)
dtsep (esm_calendar.esm_calendar.Dateformat attribute)
E
edit_dataset() (esm_database.esm_database.DisplayDatabase method)
EDITABLE_INSTALL (in module esm_tools)
esm_archiving
module
esm_archiving.cli
module
esm_archiving.config
module
esm_archiving.esm_archiving
module
esm_archiving.external
module
esm_archiving.external.pypftp
module
esm_calendar
module
esm_calendar.esm_calendar
module
esm_cleanup
module
esm_cleanup.cli
module
esm_cleanup.esm_cleanup
module
esm_database
module
esm_database.cli
module
esm_database.esm_database
module
esm_database.getch
module
esm_database.location_database
module
esm_master
module
esm_master.database
module
esm_master.database_actions
module
esm_master.software_package
module
esm_parser.dict_to_yaml
module
esm_parser.provenance
module
esm_profile
module
esm_profile.esm_profile
module
esm_tests_info
esm_tools
module
esm_utilities
module
esm_utilities.cli
module
esm_utilities.esm_utilities
module
esm_utilities.utils
module
evaluate_arguments() (in module esm_cleanup.cli)
exists() (esm_archiving.external.pypftp.Pftp method)
extend_and_modified_by() (esm_parser.provenance.Provenance method)
F
file_size() (in module esm_cleanup.esm_cleanup)
files() (esm_archiving.external.pypftp.Pftp method)
fill_in_infos() (esm_master.software_package.software_package method)
find_indices_of() (in module esm_archiving)
(in module esm_archiving.esm_archiving)
find_remaining_hours() (in module esm_calendar.esm_calendar)
find_remaining_minutes() (in module esm_calendar.esm_calendar)
folder (esm_master.database.installation attribute)
format() (esm_calendar.esm_calendar.Date method)
format_size() (in module esm_cleanup.esm_cleanup)
from_list() (esm_calendar.esm_calendar.Date class method)
fromlist() (esm_calendar.esm_calendar.Date class method)
G
get_command_list() (esm_master.software_package.software_package method)
get_comp_type() (esm_master.software_package.software_package method)
get_config_as_str() (in module esm_tools)
get_config_filepath() (in module esm_tools)
get_coupling_changes() (esm_master.software_package.software_package method)
get_coupling_filepath() (in module esm_tools)
get_files_for_date_range() (in module esm_archiving)
(in module esm_archiving.esm_archiving)
get_list_from_filepattern() (in module esm_archiving)
(in module esm_archiving.esm_archiving)
get_namelist_filepath() (in module esm_tools)
get_one_of() (in module esm_database.getch)
get_provenance() (esm_parser.provenance.DictWithProvenance method)
(esm_parser.provenance.ListWithProvenance method)
get_repo_info() (esm_master.software_package.software_package method)
get_runscript_filepath() (in module esm_tools)
get_subpackages() (esm_master.software_package.software_package method)
get_targets() (esm_master.software_package.software_package method)
get_timing_info() (in module esm_profile.esm_profile)
group_files() (in module esm_archiving)
(in module esm_archiving.esm_archiving)
group_indexes() (in module esm_archiving)
(in module esm_archiving.esm_archiving)
H
HOST (esm_archiving.external.pypftp.Pftp attribute)
hour (esm_calendar.esm_calendar.Date attribute)
I
id (esm_database.location_database.database_location attribute)
(esm_master.database.installation attribute)
inspect_size() (in module esm_cleanup.esm_cleanup)
installation (class in esm_master.database)
is_connected() (esm_archiving.external.pypftp.Pftp method)
is_experiment_folder() (in module esm_cleanup.esm_cleanup)
isdir() (esm_archiving.external.pypftp.Pftp method)
isfile() (esm_archiving.external.pypftp.Pftp method)
isleapyear() (esm_calendar.esm_calendar.Calendar method)
,
[1]
islink() (esm_archiving.external.pypftp.Pftp method)
K
keep_provenance_in_recursive_function() (in module esm_parser.provenance)
L
last-state
list_config_dir() (in module esm_tools)
listdir() (esm_archiving.external.pypftp.Pftp method)
listing() (esm_archiving.external.pypftp.Pftp method)
listing2() (esm_archiving.external.pypftp.Pftp method)
ListWithProvenance (class in esm_parser.provenance)
load_config() (in module esm_archiving.config)
location (esm_database.location_database.database_location attribute)
log_tarfile_contents() (in module esm_archiving)
(in module esm_archiving.esm_archiving)
logfile_stats() (in module esm_utilities.utils)
M
main() (in module esm_cleanup.cli)
(in module esm_database.cli)
main_loop() (in module esm_cleanup.cli)
makedirs() (esm_archiving.external.pypftp.Pftp method)
makesense() (esm_calendar.esm_calendar.Date method)
minute (esm_calendar.esm_calendar.Date attribute)
mkdir() (esm_archiving.external.pypftp.Pftp method)
mlsd() (esm_archiving.external.pypftp.Pftp method)
module
esm_archiving
esm_archiving.cli
esm_archiving.config
esm_archiving.esm_archiving
esm_archiving.external
esm_archiving.external.pypftp
esm_calendar
esm_calendar.esm_calendar
esm_cleanup
esm_cleanup.cli
esm_cleanup.esm_cleanup
esm_database
esm_database.cli
esm_database.esm_database
esm_database.getch
esm_database.location_database
esm_master
esm_master.database
esm_master.database_actions
esm_master.software_package
esm_parser.dict_to_yaml
esm_parser.provenance
esm_profile
esm_profile.esm_profile
esm_tools
esm_utilities
esm_utilities.cli
esm_utilities.esm_utilities
esm_utilities.utils
month (esm_calendar.esm_calendar.Date attribute)
monthnames (esm_calendar.esm_calendar.Calendar attribute)
,
[1]
N
nicer_output() (esm_master.database.installation static method)
NoneWithProvenance (class in esm_parser.provenance)
O
output() (esm_calendar.esm_calendar.Date method)
(esm_master.software_package.software_package method)
output_writer() (esm_database.esm_database.DisplayDatabase method)
P
pack_tarfile() (in module esm_archiving)
(in module esm_archiving.esm_archiving)
parse_shargs() (in module esm_database.cli)
Pftp (class in esm_archiving.external.pypftp)
pick_experiment_folder() (in module esm_cleanup.esm_cleanup)
pick_subfolder() (in module esm_cleanup.esm_cleanup)
PORT (esm_archiving.external.pypftp.Pftp attribute)
print_disclaimer() (in module esm_cleanup.esm_cleanup)
print_folder_content() (in module esm_cleanup.esm_cleanup)
print_profile_summary() (in module esm_profile.esm_profile)
Provenance (class in esm_parser.provenance)
provenance (esm_parser.provenance.ProvenanceClassForTheUnsubclassable property)
ProvenanceClassForTheUnsubclassable (class in esm_parser.provenance)
purify_expid_in() (in module esm_archiving)
(in module esm_archiving.esm_archiving)
put_provenance() (esm_parser.provenance.DictWithProvenance method)
(esm_parser.provenance.ListWithProvenance method)
pwd() (esm_archiving.external.pypftp.Pftp method)
Q
query_yes_no() (in module esm_archiving.esm_archiving)
quit() (esm_archiving.external.pypftp.Pftp method)
R
read_config_file() (in module esm_tools)
read_in_yaml_file() (in module esm_cleanup.esm_cleanup)
read_namelist_file() (in module esm_tools)
reconnect() (esm_archiving.external.pypftp.Pftp method)
register() (in module esm_database.location_database)
remove() (esm_archiving.external.pypftp.Pftp method)
remove_datasets() (esm_database.esm_database.DisplayDatabase method)
remove_post_subfolders() (in module esm_cleanup.esm_cleanup)
remove_run_subfolders() (in module esm_cleanup.esm_cleanup)
remove_size_information() (in module esm_cleanup.esm_cleanup)
remove_some_files() (in module esm_cleanup.esm_cleanup)
remove_subfolder() (in module esm_cleanup.esm_cleanup)
removedirs() (esm_archiving.external.pypftp.Pftp method)
rename() (esm_archiving.external.pypftp.Pftp method)
replace_var() (in module esm_master.software_package)
rmdir() (esm_archiving.external.pypftp.Pftp method)
run_command() (in module esm_archiving.esm_archiving)
runscripts
S
sday (esm_calendar.esm_calendar.Date property)
sdoy (esm_calendar.esm_calendar.Date property)
second (esm_calendar.esm_calendar.Date attribute)
select_stuff() (esm_database.esm_database.DisplayDatabase method)
set_provenance() (esm_parser.provenance.DictWithProvenance method)
(esm_parser.provenance.ListWithProvenance method)
setup_name (esm_master.database.installation attribute)
shour (esm_calendar.esm_calendar.Date property)
size() (esm_archiving.external.pypftp.Pftp method)
sminute (esm_calendar.esm_calendar.Date property)
smonth (esm_calendar.esm_calendar.Date property)
software_package (class in esm_master.software_package)
sort_files_to_tarlists() (in module esm_archiving)
(in module esm_archiving.esm_archiving)
split_list_due_to_size_limit() (in module esm_archiving)
(in module esm_archiving.esm_archiving)
ssecond (esm_calendar.esm_calendar.Date property)
stamp_filepattern() (in module esm_archiving)
(in module esm_archiving.esm_archiving)
stamp_files() (in module esm_archiving)
(in module esm_archiving.esm_archiving)
stat() (esm_archiving.external.pypftp.Pftp method)
state.yaml
sub_date() (esm_calendar.esm_calendar.Date method)
sub_tuple() (esm_calendar.esm_calendar.Date method)
sum_tar_lists() (in module esm_archiving)
(in module esm_archiving.esm_archiving)
sum_tar_lists_human_readable() (in module esm_archiving)
(in module esm_archiving.esm_archiving)
syear (esm_calendar.esm_calendar.Date property)
T
table_name (esm_database.location_database.database_location attribute)
time_between() (esm_calendar.esm_calendar.Date method)
timesep (esm_calendar.esm_calendar.Dateformat attribute)
timestamp (esm_master.database.installation attribute)
timeunits (esm_calendar.esm_calendar.Calendar attribute)
,
[1]
timing() (in module esm_profile.esm_profile)
TIMING_INFO (in module esm_profile.esm_profile)
topline() (esm_database.location_database.database_location static method)
(esm_master.database.installation static method)
U
update() (esm_parser.provenance.DictWithProvenance method)
upload() (esm_archiving.external.pypftp.Pftp static method)
(in module esm_archiving.external.pypftp)
W
walk() (esm_archiving.external.pypftp.Pftp method)
walk_for_directories() (esm_archiving.external.pypftp.Pftp method)
walk_for_files() (esm_archiving.external.pypftp.Pftp method)
wrapper_with_provenance_factory() (in module esm_parser.provenance)
wrapper_with_provenance_init() (in module esm_parser.provenance)
wrapper_with_provenance_new() (in module esm_parser.provenance)
write_config_yaml() (in module esm_archiving.config)
Y
yaml_dump() (esm_parser.provenance.DictWithProvenance method)
(esm_parser.provenance.ListWithProvenance method)
(in module esm_parser.dict_to_yaml)
year (esm_calendar.esm_calendar.Date attribute)