fre package

Subpackages

• fre.analysis package
  • Subpackages
    • fre.analysis.tests package
      • Submodules
      • Module contents
  • Submodules
    • fre.analysis.freanalysis module
    • fre.analysis.subtools module
      • install_analysis_package()
      • list_plugins()
      • run_analysis()
      • uninstall_analysis_package()
  • Module contents
• fre.app package
  • Subpackages
    • fre.app.generate_time_averages package
      • Subpackages
      • Submodules
      • Module contents
    • fre.app.mask_atmos_plevel package
      • Subpackages
      • Submodules
      • Module contents
    • fre.app.regrid_xy package
      • Subpackages
      • Submodules
      • Module contents
    • fre.app.remap_pp_components package
      • Subpackages
      • Submodules
      • Module contents
    • fre.app.tests package
      • Submodules
      • Module contents
  • Submodules
    • fre.app.freapp module
    • fre.app.helpers module
      • change_directory()
      • get_variables()
  • Module contents
• fre.catalog package
  • Subpackages
    • fre.catalog.tests package
      • Submodules
      • Module contents
  • Submodules
    • fre.catalog.frecatalog module
  • Module contents
• fre.check package
  • Submodules
    • fre.check.frecheck module
    • fre.check.frecheckexample module
      • check_test_function()
  • Module contents
• fre.cmor package
  • Subpackages
    • fre.cmor.tests package
      • Submodules
      • Module contents
  • Submodules
    • fre.cmor.cmor_config module
      • CMOR YAML Configuration Generator
      • cmor_config_subtool()
    • fre.cmor.cmor_constants module
      • fre.cmor constants
    • fre.cmor.cmor_finder module
      • fre cmor find
      • cmor_find_subtool()
      • make_simple_varlist()
      • print_var_content()
    • fre.cmor.cmor_helpers module
      • fre.cmor helper functions
      • check_dataset_for_ocean_grid()
      • check_path_existence()
      • conv_mip_to_bronx_freq()
      • create_lev_bnds()
      • create_tmp_dir()
      • filter_brands()
      • find_gold_ocean_statics_file()
      • find_statics_file()
      • from_dis_gimme_dis()
      • get_bronx_freq_from_mip_table()
      • get_iso_datetime_ranges()
      • get_json_file_data()
      • get_vertical_dimension()
      • iso_to_bronx_chunk()
      • print_data_minmax()
      • update_calendar_type()
      • update_grid_and_label()
    • fre.cmor.cmor_mixer module
      • FRE / CMOR Metadata Mixing and Rewriting (CMORization)
      • cmor_run_subtool()
      • cmorize_all_variables_in_dir()
      • cmorize_target_var_files()
      • rewrite_netcdf_file_var()
    • fre.cmor.cmor_yamler module
      • YAML-Driven CMORization Workflow Tools
      • cmor_yaml_subtool()
    • fre.cmor.frecmor module
  • Module contents
• fre.list_ package
  • Subpackages
    • fre.list_.tests package
      • Submodules
      • Module contents
  • Submodules
    • fre.list_.frelist module
    • fre.list_.list_experiments_script module
      • list_experiments_subtool()
    • fre.list_.list_platforms_script module
      • list_platforms_subtool()
    • fre.list_.list_pp_components_script module
      • list_ppcomps_subtool()
  • Module contents
• fre.make package
  • Subpackages
    • fre.make.tests package
      • Subpackages
      • Submodules
      • Module contents
  • Submodules
    • fre.make.create_checkout_script module
      • baremetal_checkout_write()
      • checkout_create()
      • container_checkout_write()
    • fre.make.create_compile_script module
      • compile_create()
    • fre.make.create_docker_script module
      • dockerfile_create()
    • fre.make.create_makefile_script module
      • makefile_create()
    • fre.make.fremake module
    • fre.make.make_helpers module
      • get_mktemplate_path()
    • fre.make.run_fremake_script module
      • fremake_run()
  • Module contents
• fre.pp package
  • Subpackages
    • fre.pp.tests package
      • Submodules
      • Module contents
  • Submodules
    • fre.pp.checkout_script module
      • checkout_template()
    • fre.pp.configure_script_yaml module
      • quote_rose_values()
      • rose_init()
      • set_rose_apps()
      • set_rose_suite()
      • validate_yaml()
      • yaml_info()
    • fre.pp.frepp module
    • fre.pp.histval_script module
      • validate()
    • fre.pp.install_script module
      • install_subtool()
    • fre.pp.nccheck_script module
      • check()
    • fre.pp.ppval_script module
      • getenot()
      • validate()
    • fre.pp.run_script module
      • pp_run_subtool()
    • fre.pp.split_netcdf_script module
      • fre_outfile_name()
      • get_max_ndims()
      • set_coord_encoding()
      • set_var_encoding()
      • split_file_xarray()
      • split_netcdf()
    • fre.pp.status_script module
      • status_subtool()
    • fre.pp.trigger_script module
      • trigger()
    • fre.pp.validate_script module
      • validate_subtool()
    • fre.pp.wrapper_script module
      • run_all_fre_pp_steps()
  • Module contents
    • make_workflow_name()
• fre.run package
  • Submodules
    • fre.run.frerun module
    • fre.run.frerunexample module
      • run_test_function()
  • Module contents
• fre.tests package
  • Submodules
    • fre.tests.test_fre_analysis_cli module
      • test_cli_fre_analysis()
      • test_cli_fre_analysis_help()
      • test_cli_fre_analysis_install_help()
      • test_cli_fre_analysis_install_missing_url()
      • test_cli_fre_analysis_install_unknown_argument()
      • test_cli_fre_analysis_run_help()
      • test_cli_fre_analysis_run_missing_catalog()
      • test_cli_fre_analysis_run_missing_experiment_yaml()
      • test_cli_fre_analysis_run_missing_name()
      • test_cli_fre_analysis_run_missing_output_directory()
      • test_cli_fre_analysis_run_missing_output_yaml()
      • test_cli_fre_analysis_run_unknown_argument()
      • test_cli_fre_analysis_uninstall_help()
      • test_cli_fre_analysis_uninstall_missing_name()
      • test_cli_fre_analysis_uninstall_unknown_argument()
    • fre.tests.test_fre_app_cli module
      • test_cli_fre_app()
      • test_cli_fre_app_combine_time_averages()
      • test_cli_fre_app_combine_time_averages_case()
      • test_cli_fre_app_combine_time_averages_help()
      • test_cli_fre_app_combine_time_averages_opt_dne()
      • test_cli_fre_app_gen_time_averages()
      • test_cli_fre_app_gen_time_averages_case()
      • test_cli_fre_app_gen_time_averages_help()
      • test_cli_fre_app_gen_time_averages_opt_dne()
      • test_cli_fre_app_gen_time_averages_wrapper()
      • test_cli_fre_app_gen_time_averages_wrapper_case()
      • test_cli_fre_app_gen_time_averages_wrapper_help()
      • test_cli_fre_app_gen_time_averages_wrapper_opt_dne()
      • test_cli_fre_app_help()
      • test_cli_fre_app_mask_atmos_plevel()
      • test_cli_fre_app_mask_atmos_plevel_exception()
      • test_cli_fre_app_mask_atmos_plevel_help()
      • test_cli_fre_app_mask_atmos_plevel_opt_dne()
      • test_cli_fre_app_opt_dne()
      • test_cli_fre_app_regrid()
      • test_cli_fre_app_regrid_help()
      • test_cli_fre_app_regrid_opt_dne()
      • test_cli_fre_app_regrid_test_case_1()
      • test_cli_fre_app_remap()
      • test_cli_fre_app_remap_help()
      • test_cli_fre_app_remap_opt_dne()
    • fre.tests.test_fre_catalog_cli module
      • test_cli_fre_catalog()
      • test_cli_fre_catalog_build()
      • test_cli_fre_catalog_build_help()
      • test_cli_fre_catalog_help()
      • test_cli_fre_catalog_merge()
      • test_cli_fre_catalog_merge_help()
      • test_cli_fre_catalog_opt_dne()
    • fre.tests.test_fre_check_cli module
      • test_cli_fre_check()
      • test_cli_fre_check_help()
      • test_cli_fre_check_opt_dne()
    • fre.tests.test_fre_cli module
      • test_cli_fre()
      • test_cli_fre_help()
      • test_cli_fre_option_dne()
      • test_cli_fre_version()
      • test_fre_version()
    • fre.tests.test_fre_cmor_cli module
      • test_cli_fre_cmor()
      • test_cli_fre_cmor_config()
      • test_cli_fre_cmor_config_case1()
      • test_cli_fre_cmor_config_help()
      • test_cli_fre_cmor_config_opt_dne()
      • test_cli_fre_cmor_find()
      • test_cli_fre_cmor_find_cmip6_case1()
      • test_cli_fre_cmor_find_cmip6_case2()
      • test_cli_fre_cmor_find_help()
      • test_cli_fre_cmor_find_opt_dne()
      • test_cli_fre_cmor_help()
      • test_cli_fre_cmor_help_and_debuglog()
      • test_cli_fre_cmor_help_and_infolog()
      • test_cli_fre_cmor_help_and_quietlog()
      • test_cli_fre_cmor_opt_dne()
      • test_cli_fre_cmor_run()
      • test_cli_fre_cmor_run_case1()
      • test_cli_fre_cmor_run_case2()
      • test_cli_fre_cmor_run_cmip7_case1()
      • test_cli_fre_cmor_run_cmip7_case2()
      • test_cli_fre_cmor_run_help()
      • test_cli_fre_cmor_run_opt_dne()
      • test_cli_fre_cmor_varlist()
      • test_cli_fre_cmor_varlist_cmip6_table_filter()
      • test_cli_fre_cmor_varlist_cmip7_table_filter()
      • test_cli_fre_cmor_varlist_help()
      • test_cli_fre_cmor_varlist_no_table_filter()
      • test_cli_fre_cmor_varlist_opt_dne()
      • test_cli_fre_cmor_yaml()
      • test_cli_fre_cmor_yaml_case1()
      • test_cli_fre_cmor_yaml_help()
      • test_cli_fre_cmor_yaml_opt_dne()
      • test_setup_test_files()
    • fre.tests.test_fre_list_cli module
      • test_cli_fre_list()
      • test_cli_fre_list_exps()
      • test_cli_fre_list_exps_help()
      • test_cli_fre_list_exps_opt_dne()
      • test_cli_fre_list_help()
      • test_cli_fre_list_opt_dne()
      • test_cli_fre_list_platforms()
    • fre.tests.test_fre_make_cli module
      • test_cli_fre_make()
      • test_cli_fre_make_create_checkout_baremetal()
      • test_cli_fre_make_create_checkout_baremetal_npc()
      • test_cli_fre_make_create_checkout_cleanup()
      • test_cli_fre_make_create_checkout_container()
      • test_cli_fre_make_help()
      • test_cli_fre_make_opt_dne()
    • fre.tests.test_fre_pp_cli module
      • test_cli_fre_pp()
      • test_cli_fre_pp_checkout()
      • test_cli_fre_pp_checkout_case()
      • test_cli_fre_pp_checkout_help()
      • test_cli_fre_pp_checkout_opt_dne()
      • test_cli_fre_pp_configure_yaml()
      • test_cli_fre_pp_configure_yaml_fail1()
      • test_cli_fre_pp_configure_yaml_help()
      • test_cli_fre_pp_configure_yaml_opt_dne()
      • test_cli_fre_pp_help()
      • test_cli_fre_pp_install()
      • test_cli_fre_pp_install_help()
      • test_cli_fre_pp_install_opt_dne()
      • test_cli_fre_pp_opt_dne()
      • test_cli_fre_pp_run()
      • test_cli_fre_pp_run_help()
      • test_cli_fre_pp_run_opt_dne()
      • test_cli_fre_pp_split_netcdf()
      • test_cli_fre_pp_split_netcdf_help()
      • test_cli_fre_pp_split_netcdf_opt_dne()
      • test_cli_fre_pp_split_netcdf_wrapper()
      • test_cli_fre_pp_split_netcdf_wrapper_help()
      • test_cli_fre_pp_split_netcdf_wrapper_opt_dne()
      • test_cli_fre_pp_status()
      • test_cli_fre_pp_status_help()
      • test_cli_fre_pp_status_opt_dne()
      • test_cli_fre_pp_status_security_check()
      • test_cli_fre_pp_validate()
      • test_cli_fre_pp_validate_help()
      • test_cli_fre_pp_validate_opt_dne()
      • test_cli_fre_pp_wrapper()
      • test_cli_fre_pp_wrapper_help()
      • test_cli_fre_pp_wrapper_opt_dne()
    • fre.tests.test_fre_run_cli module
      • test_cli_fre_run()
      • test_cli_fre_run_help()
      • test_cli_fre_run_opt_dne()
    • fre.tests.test_fre_yamltools_cli module
      • test_cli_fre_yamltools()
      • test_cli_fre_yamltools_combine_cmoryaml()
      • test_cli_fre_yamltools_combine_help()
      • test_cli_fre_yamltools_combine_opt_dne()
      • test_cli_fre_yamltools_help()
      • test_cli_fre_yamltools_opt_dne()
  • Module contents
• fre.yamltools package
  • Subpackages
    • fre.yamltools.tests package
      • Submodules
      • Module contents
  • Submodules
    • fre.yamltools.abstract_classes module
      • MergeCompileYamls
      • MergePPANYamls
    • fre.yamltools.combine_yamls_script module
      • YAML Combination Utilities for FRE
      • Functions
      • consolidate_yamls()
      • get_combined_cmoryaml()
    • fre.yamltools.constructors module
    • fre.yamltools.freyamltools module
    • fre.yamltools.helpers module
      • clean_yaml()
      • experiment_check()
      • output_yaml()
      • validate_yaml()
      • yaml_load()
  • Module contents

Submodules

• fre.fre module
• fre.lazy_group module
  • LazyGroup
    • LazyGroup.get_command()
    • LazyGroup.list_commands()

Module contents

module init file for fre. sets the version attribute, and sets up a fre_logger