ESM Tools Code Documentation

• esm_archiving package
  • archive_mistral()
  • check_tar_lists()
  • delete_original_data()
  • determine_datestamp_location()
  • determine_potential_datestamp_locations()
  • find_indices_of()
  • get_files_for_date_range()
  • get_list_from_filepattern()
  • group_files()
  • group_indexes()
  • log_tarfile_contents()
  • pack_tarfile()
  • purify_expid_in()
  • sort_files_to_tarlists()
  • split_list_due_to_size_limit()
  • stamp_filepattern()
  • stamp_files()
  • sum_tar_lists()
  • sum_tar_lists_human_readable()
  • Subpackages
    • esm_archiving.external package
      • Submodules
      • esm_archiving.external.pypftp module
        • Pftp
          • Pftp.HOST
          • Pftp.PORT
          • Pftp.close()
          • Pftp.cwd()
          • Pftp.directories()
          • Pftp.download()
          • Pftp.exists()
          • Pftp.files()
          • Pftp.is_connected()
          • Pftp.isdir()
          • Pftp.isfile()
          • Pftp.islink()
          • Pftp.listdir()
          • Pftp.listing()
          • Pftp.listing2()
          • Pftp.makedirs()
          • Pftp.mkdir()
          • Pftp.mlsd()
          • Pftp.pwd()
          • Pftp.quit()
          • Pftp.reconnect()
          • Pftp.remove()
          • Pftp.removedirs()
          • Pftp.rename()
          • Pftp.rmdir()
          • Pftp.size()
          • Pftp.stat()
          • Pftp.upload()
          • Pftp.walk()
          • Pftp.walk_for_directories()
          • Pftp.walk_for_files()
        • download()
        • upload()
  • Submodules
  • esm_archiving.cli module
    • Creating tarballs
    • Uploading tarballs
  • esm_archiving.config module
    • Generating a configuration
    • load_config()
    • write_config_yaml()
  • esm_archiving.esm_archiving module
    • DatestampLocationError
    • archive_mistral()
    • check_tar_lists()
    • delete_original_data()
    • determine_datestamp_location()
    • determine_potential_datestamp_locations()
    • find_indices_of()
    • get_files_for_date_range()
    • get_list_from_filepattern()
    • group_files()
    • group_indexes()
    • log_tarfile_contents()
    • pack_tarfile()
    • purify_expid_in()
    • query_yes_no()
    • run_command()
    • sort_files_to_tarlists()
    • split_list_due_to_size_limit()
    • stamp_filepattern()
    • stamp_files()
    • sum_tar_lists()
    • sum_tar_lists_human_readable()
• esm_archiving.external package
  • Submodules
  • esm_archiving.external.pypftp module
    • Pftp
      • Pftp.HOST
      • Pftp.PORT
      • Pftp.close()
      • Pftp.cwd()
      • Pftp.directories()
      • Pftp.download()
      • Pftp.exists()
      • Pftp.files()
      • Pftp.is_connected()
      • Pftp.isdir()
      • Pftp.isfile()
      • Pftp.islink()
      • Pftp.listdir()
      • Pftp.listing()
      • Pftp.listing2()
      • Pftp.makedirs()
      • Pftp.mkdir()
      • Pftp.mlsd()
      • Pftp.pwd()
      • Pftp.quit()
      • Pftp.reconnect()
      • Pftp.remove()
      • Pftp.removedirs()
      • Pftp.rename()
      • Pftp.rmdir()
      • Pftp.size()
      • Pftp.stat()
      • Pftp.upload()
      • Pftp.walk()
      • Pftp.walk_for_directories()
      • Pftp.walk_for_files()
    • download()
    • upload()
• esm_calendar package
  • Submodules
  • esm_calendar.esm_calendar module
    • Calendar
      • Calendar.timeunits
      • Calendar.monthnames
      • Calendar.isleapyear()
      • Calendar.day_in_year()
      • Calendar.day_in_month()
      • Calendar.day_in_month()
      • Calendar.day_in_year()
      • Calendar.isleapyear()
      • Calendar.monthnames
      • Calendar.timeunits
    • Date
      • Date.year
      • Date.month
      • Date.day
      • Date.hour
      • Date.minute
      • Date.second
      • Date._calendar
      • Date.add()
      • Date.day_of_year()
      • Date.format()
      • Date.from_list()
      • Date.fromlist()
      • Date.makesense()
      • Date.output()
      • Date.sday
      • Date.sdoy
      • Date.shour
      • Date.sminute
      • Date.smonth
      • Date.ssecond
      • Date.sub_date()
      • Date.sub_tuple()
      • Date.syear
      • Date.time_between()
    • Dateformat
      • Dateformat.datesep
      • Dateformat.dtsep
      • Dateformat.timesep
    • date_range()
    • find_remaining_hours()
    • find_remaining_minutes()
• esm_cleanup package
  • Submodules
  • esm_cleanup.cli module
    • evaluate_arguments()
    • main()
    • main_loop()
  • esm_cleanup.esm_cleanup module
    • add_size_information()
    • ask_for_action()
    • assert_question()
    • check_if_folder_exists()
    • dir_size()
    • file_size()
    • format_size()
    • inspect_size()
    • is_experiment_folder()
    • pick_experiment_folder()
    • pick_subfolder()
    • print_disclaimer()
    • print_folder_content()
    • read_in_yaml_file()
    • remove_post_subfolders()
    • remove_run_subfolders()
    • remove_size_information()
    • remove_some_files()
    • remove_subfolder()
• esm_database package
  • Submodules
  • esm_database.cli module
    • main()
    • parse_shargs()
  • esm_database.esm_database module
    • DisplayDatabase
      • DisplayDatabase.ask_column()
      • DisplayDatabase.ask_dataset()
      • DisplayDatabase.decision_maker()
      • DisplayDatabase.edit_dataset()
      • DisplayDatabase.output_writer()
      • DisplayDatabase.remove_datasets()
      • DisplayDatabase.select_stuff()
  • esm_database.getch module
    • get_one_of()
  • esm_database.location_database module
    • database_location
      • database_location.class_in
      • database_location.id
      • database_location.location
      • database_location.table_name
      • database_location.topline()
    • register()
• esm_environment package
  • Submodules
  • esm_environment.esm_environment module
• esm_master package
  • Submodules
  • esm_master.cli module
  • esm_master.compile_info module
  • esm_master.database module
    • installation
      • installation.action
      • installation.folder
      • installation.id
      • installation.nicer_output()
      • installation.setup_name
      • installation.timestamp
      • installation.topline()
  • esm_master.database_actions module
    • database_entry()
  • esm_master.esm_master module
  • esm_master.general_stuff module
  • esm_master.software_package module
    • replace_var()
    • software_package
      • software_package.complete_targets()
      • software_package.fill_in_infos()
      • software_package.get_command_list()
      • software_package.get_comp_type()
      • software_package.get_coupling_changes()
      • software_package.get_repo_info()
      • software_package.get_subpackages()
      • software_package.get_targets()
      • software_package.output()
  • esm_master.task module
• esm_motd package
  • Submodules
  • esm_motd.esm_motd module
• esm_parser package
  • Submodules
  • esm_parser.dict_to_yaml module
    • add_eol_comments_with_provenance()
    • delete_prev_objects()
    • yaml_dump()
  • esm_parser.esm_parser module
  • esm_parser.provenance module
    • BoolWithProvenance
    • DictWithProvenance
      • DictWithProvenance.extract_first_nested_values_provenance()
      • DictWithProvenance.get_provenance()
      • DictWithProvenance.put_provenance()
      • DictWithProvenance.set_provenance()
      • DictWithProvenance.update()
      • DictWithProvenance.yaml_dump()
    • ListWithProvenance
      • ListWithProvenance.extract_first_nested_values_provenance()
      • ListWithProvenance.get_provenance()
      • ListWithProvenance.put_provenance()
      • ListWithProvenance.set_provenance()
      • ListWithProvenance.yaml_dump()
    • NoneWithProvenance
    • Provenance
      • Provenance.add_modified_by()
      • Provenance.append_last_step_modified_by()
      • Provenance.extend_and_modified_by()
    • ProvenanceClassForTheUnsubclassable
      • ProvenanceClassForTheUnsubclassable.provenance
    • clean_provenance()
    • keep_provenance_in_recursive_function()
    • wrapper_with_provenance_factory()
    • wrapper_with_provenance_init()
    • wrapper_with_provenance_new()
  • esm_parser.yaml_to_dict module
• esm_plugin_manager package
  • Submodules
  • esm_plugin_manager.cli module
  • esm_plugin_manager.esm_plugin_manager module
• esm_profile package
  • Submodules
  • esm_profile.esm_profile module
    • TIMING_INFO
    • get_timing_info()
    • print_profile_summary()
    • timing()
• esm_runscripts package
  • Submodules
  • esm_runscripts.assembler module
  • esm_runscripts.batch_system module
  • esm_runscripts.chunky_parts module
  • esm_runscripts.cli module
  • esm_runscripts.compute module
  • esm_runscripts.config_initialization module
  • esm_runscripts.coupler module
  • esm_runscripts.database module
  • esm_runscripts.database_actions module
  • esm_runscripts.dataprocess module
  • esm_runscripts.event_handlers module
  • esm_runscripts.filelists module
  • esm_runscripts.helpers module
  • esm_runscripts.inspect module
  • esm_runscripts.jinja module
  • esm_runscripts.last_minute module
  • esm_runscripts.logfiles module
  • esm_runscripts.methods module
  • esm_runscripts.mpirun module
  • esm_runscripts.namelists module
  • esm_runscripts.oasis module
  • esm_runscripts.observe module
  • esm_runscripts.pbs module
  • esm_runscripts.postprocess module
  • esm_runscripts.prepare module
  • esm_runscripts.prepcompute module
  • esm_runscripts.prepexp module
  • esm_runscripts.prev_run module
  • esm_runscripts.resubmit module
  • esm_runscripts.sim_objects module
  • esm_runscripts.slurm module
  • esm_runscripts.tidy module
  • esm_runscripts.virtual_env_builder module
  • esm_runscripts.workflow module
  • esm_runscripts.yac module
• esm_tests package
  • Submodules
  • esm_tests.cli module
  • esm_tests.info module
  • esm_tests.initialization module
  • esm_tests.output module
  • esm_tests.read_shipped_data module
  • esm_tests.repos module
  • esm_tests.test_utilities module
  • esm_tests.tests module
• esm_tools package
  • ESM Tools (Package Documentation)
    • Accessing Configuration
  • EDITABLE_INSTALL
  • caller_wrapper()
  • copy_config_folder()
  • copy_namelist_folder()
  • copy_runscript_folder()
  • get_config_as_str()
  • get_config_filepath()
  • get_coupling_filepath()
  • get_namelist_filepath()
  • get_runscript_filepath()
  • list_config_dir()
  • read_config_file()
  • read_namelist_file()
  • Submodules
  • esm_tools.cli module
  • esm_tools.error_handling module
    • user_error()
    • user_note()
    • user_note_hints()
• esm_utilities package
  • Submodules
  • esm_utilities.cli module
  • esm_utilities.esm_utilities module
  • esm_utilities.utils module
    • check_valid_version()
    • logfile_stats()