fremor package

Subpackages

• fremor.tests package
  • Submodules
    • fremor.tests.conftest module
      • cli_mapped_nc_file()
      • cli_sos_nc_file()
      • cli_sosv2_nc_file()
      • cmip6_exp_config()
      • cmip7_exp_config()
      • ncgen()
    • fremor.tests.test_cli module
      • test_cli_fremor()
      • test_cli_fremor_config()
      • test_cli_fremor_config_case1()
      • test_cli_fremor_config_help()
      • test_cli_fremor_config_opt_dne()
      • test_cli_fremor_find()
      • test_cli_fremor_find_cmip6_case1()
      • test_cli_fremor_find_cmip6_case2()
      • test_cli_fremor_find_help()
      • test_cli_fremor_find_opt_dne()
      • test_cli_fremor_help()
      • test_cli_fremor_help_and_debuglog()
      • test_cli_fremor_help_and_infolog()
      • test_cli_fremor_help_and_quietlog()
      • test_cli_fremor_init()
      • test_cli_fremor_init_cmip6_exp_config()
      • test_cli_fremor_init_cmip7_exp_config()
      • test_cli_fremor_init_default_name()
      • test_cli_fremor_init_help()
      • test_cli_fremor_init_opt_dne()
      • test_cli_fremor_opt_dne()
      • test_cli_fremor_resolve()
      • test_cli_fremor_resolve_case1()
      • test_cli_fremor_resolve_case2_stdout()
      • test_cli_fremor_resolve_help()
      • test_cli_fremor_resolve_opt_dne()
      • test_cli_fremor_run()
      • test_cli_fremor_run_case1()
      • test_cli_fremor_run_case2()
      • test_cli_fremor_run_case3()
      • test_cli_fremor_run_cmip7_case1()
      • test_cli_fremor_run_cmip7_case2()
      • test_cli_fremor_run_cmip7_case3()
      • test_cli_fremor_run_help()
      • test_cli_fremor_run_opt_dne()
      • test_cli_fremor_run_with_logfile()
      • test_cli_fremor_run_with_logfile_omission_case()
      • test_cli_fremor_varlist()
      • test_cli_fremor_varlist_cmip6_table_filter()
      • test_cli_fremor_varlist_cmip7_table_filter()
      • test_cli_fremor_varlist_help()
      • test_cli_fremor_varlist_no_table_filter()
      • test_cli_fremor_varlist_opt_dne()
      • test_cli_fremor_yaml()
      • test_cli_fremor_yaml_case1()
      • test_cli_fremor_yaml_help()
      • test_cli_fremor_yaml_opt_dne()
      • test_setup_test_files()
    • fremor.tests.test_cmor_config_subtool module
      • temp_dir()
      • test_cmor_config_subtool_noexpcfg_err()
      • test_cmor_config_subtool_nomip6_tables_in_mip7_tables_err()
      • test_cmor_config_subtool_nomip7_tables_in_mip6_tables_err()
      • test_cmor_config_subtool_noppdir_err()
      • test_cmor_config_subtool_notabledir_err()
      • test_cmor_config_subtool_writes_self_contained_yaml()
    • fremor.tests.test_cmor_find_subtool module
      • test_find_subtool_no_json_dir_err()
      • test_find_subtool_no_json_files_in_dir_err()
      • test_find_subtool_no_varlist_no_optvarname_err()
      • test_make_simple_varlist()
    • fremor.tests.test_cmor_finder_make_simple_varlist module
      • temp_netcdf_dir_file()
      • temp_netcdf_dir_files()
      • test_make_simple_varlist_dedup_across_datetimes()
      • test_make_simple_varlist_deduplicates()
      • test_make_simple_varlist_invalid_output_path()
      • test_make_simple_varlist_minority_datetime_var_included()
      • test_make_simple_varlist_mip_table_filter()
      • test_make_simple_varlist_mip_table_no_match()
      • test_make_simple_varlist_no_files()
      • test_make_simple_varlist_no_files_matching_pattern()
      • test_make_simple_varlist_no_matching_pattern()
      • test_make_simple_varlist_return_value_only()
      • test_make_simple_varlist_single_file_hits_warning()
      • test_make_simple_varlist_single_file_warning()
      • test_make_simple_varlist_success()
    • fremor.tests.test_cmor_helpers module
      • test_create_lev_bnds_length_mismatch()
      • test_create_lev_bnds_length_mismatch_too_long()
      • test_create_tmp_dir_oserror()
      • test_create_tmp_dir_success()
      • test_create_tmp_dir_with_exp_config()
      • test_filter_brands_all_eliminated()
      • test_filter_brands_multiple_remain()
      • test_filter_brands_time_filter_selects_inst()
      • test_filter_brands_time_filter_selects_mean()
      • test_filter_brands_vertical_filter()
      • test_find_gold_ocean_statics_file_archive_missing()
      • test_find_gold_ocean_statics_file_mock_copy()
      • test_find_gold_ocean_statics_file_none_arg()
      • test_find_statics_file_nothing_found()
      • test_find_statics_file_success()
      • test_get_bronx_freq_from_mip_table_invalid_freq()
      • test_get_bronx_freq_from_mip_table_no_freq()
      • test_get_bronx_freq_from_mip_table_success()
      • test_get_iso_datetime_ranges_no_filter()
      • test_get_iso_datetime_ranges_no_matches_raises()
      • test_get_iso_datetime_ranges_none_arr_raises()
      • test_get_iso_datetime_ranges_with_start()
      • test_get_iso_datetime_ranges_with_start_and_stop()
      • test_get_iso_datetime_ranges_with_stop()
      • test_get_json_file_data_invalid_json()
      • test_get_json_file_data_nonexistent()
      • test_get_json_file_data_success()
      • test_iso_to_bronx_chunk()
      • test_print_data_minmax_no_exception_case1()
      • test_print_data_minmax_no_exception_case2()
      • test_print_data_minmax_no_exception_case3()
      • test_update_grid_and_label_none_grid()
      • test_update_grid_and_label_none_grid_label()
      • test_update_grid_and_label_none_nom_res()
    • fremor.tests.test_cmor_helpers_update_calendar module
      • temp_json_file()
      • temp_jsondecodeerr_json_file()
      • temp_keyerr_json_file()
      • test_calendars_are_equivalent_365_day_and_noleap()
      • test_calendars_are_equivalent_all_leap_and_366_day()
      • test_calendars_are_equivalent_case_insensitive()
      • test_calendars_are_equivalent_different_calendars()
      • test_calendars_are_equivalent_noleap_and_365_day()
      • test_calendars_are_equivalent_same_name()
      • test_calendars_are_equivalent_standard_and_gregorian()
      • test_get_time_calendar_fallback_calendar_type()
      • test_get_time_calendar_missing_returns_none()
      • test_get_time_calendar_prefers_calendar_attr()
      • test_normalize_calendar_365_day_passthrough()
      • test_normalize_calendar_366_day_passthrough()
      • test_normalize_calendar_all_leap()
      • test_normalize_calendar_gregorian_passthrough()
      • test_normalize_calendar_noleap()
      • test_normalize_calendar_none()
      • test_normalize_calendar_standard()
      • test_normalize_calendar_unknown_passthrough()
      • test_update_calendar_type_alias_normalized()
      • test_update_calendar_type_json_dne_raise()
      • test_update_calendar_type_jsondecode_raise()
      • test_update_calendar_type_keyerror_raise()
      • test_update_calendar_type_success()
      • test_update_calendar_type_unknown_err()
      • test_update_calendar_type_valerr_raise()
    • fremor.tests.test_cmor_helpers_update_grid_label module
      • temp_json_file()
      • test_invalid_json_file()
      • test_missing_grid_field()
      • test_missing_grid_label_field()
      • test_missing_nom_res_field()
      • test_nonexistent_file()
      • test_update_grid_label_and_grid_success()
    • fremor.tests.test_cmor_init_subtool module
      • test_cmor_init_invalid_mip_era()
      • test_cmor_init_tables_dir_and_exp_config()
      • test_cmor_init_tables_dir_only_no_exp_config()
      • test_cmor_init_tables_dir_with_curl()
      • test_cmor_init_tables_dir_with_git()
      • test_fetch_tables_curl_directly()
      • test_fetch_tables_curl_with_tag()
      • test_fetch_tables_git_directly()
      • test_fetch_tables_git_with_tag()
    • fremor.tests.test_cmor_mixer_calendar_integration module
      • Calendar-type integration tests for cmor_run_subtool
      • exp_config_file()
      • fake_nc_filenames()
      • table_config_file()
      • test_cmor_run_no_cal_type()
      • test_cmor_run_w_cal_type()
      • var_list_file()
    • fremor.tests.test_cmor_mixer_omission_tracking module
      • Tests for omission tracking in cmorize_all_variables_in_dir
      • test_no_omission_log_when_all_succeed()
      • test_omission_tracking_mixed_success_failure()
      • test_omission_tracking_multiple_failures()
      • test_omission_tracking_single_failure()
    • fremor.tests.test_cmor_resolver module
      • test_load_yaml_dict_empty_file()
      • test_load_yaml_dict_non_mapping()
      • test_resolve_cmor_ref_as_string()
      • test_resolve_fremor_yaml_am5_matches_expected()
      • test_resolve_fremor_yaml_esm4_grid_and_chunk()
      • test_resolve_fremor_yaml_esm4_matches_expected()
      • test_resolve_fremor_yaml_writes_output()
      • test_resolve_grid_yaml_ref_as_string()
      • test_resolve_missing_experiment()
      • test_resolve_multiple_cmor_refs()
      • test_resolve_no_cmor_ref()
      • test_resolve_yaml_reference_absolute()
      • test_resolve_yaml_reference_relative()
    • fremor.tests.test_cmor_run_subtool module
      • test_cmip6_exp_with_cmip7_table_raises()
      • test_cmip7_exp_with_cmip6_table_raises()
      • test_cmor_run_subtool_raise_value_error()
      • test_exp_config_cleanup()
      • test_fre_cmor_run_subtool_case1()
      • test_fre_cmor_run_subtool_case1_output_compare_data()
      • test_fre_cmor_run_subtool_case1_output_compare_metadata()
      • test_fre_cmor_run_subtool_case2()
      • test_fre_cmor_run_subtool_case3()
      • test_fre_cmor_run_subtool_case3_output_compare_data()
      • test_fre_cmor_run_subtool_case3_output_compare_metadata()
      • test_fre_cmor_run_subtool_empty_varlist()
      • test_fre_cmor_run_subtool_missing_mip_era()
      • test_fre_cmor_run_subtool_no_exp_config()
      • test_fre_cmor_run_subtool_opt_var_name_not_in_table()
      • test_fre_cmor_run_subtool_unsupported_mip_era()
      • test_setup_cmor_cmip_table_repo()
      • test_setup_fre_cmor_run_subtool()
      • test_setup_fre_cmor_run_subtool_case2()
      • test_setup_fre_cmor_run_subtool_case3()
    • fremor.tests.test_cmor_run_subtool_cmip7 module
      • test_cmor_run_subtool_cmip7_raise_value_error()
      • test_fre_cmor_run_subtool_cmip7_case1()
      • test_fre_cmor_run_subtool_cmip7_case1_output_compare_data()
      • test_fre_cmor_run_subtool_cmip7_case1_output_compare_metadata()
      • test_fre_cmor_run_subtool_cmip7_case2()
      • test_fre_cmor_run_subtool_cmip7_case2_output_compare_data()
      • test_fre_cmor_run_subtool_cmip7_case2_output_compare_metadata()
      • test_fre_cmor_run_subtool_cmip7_empty_varlist()
      • test_fre_cmor_run_subtool_cmip7_no_exp_config()
      • test_fre_cmor_run_subtool_cmip7_opt_var_name_not_in_table()
      • test_setup_cmip7_cmor_table_repo()
      • test_setup_fre_cmor_run_subtool_cmip7()
      • test_setup_fre_cmor_run_subtool_cmip7_case2()
    • fremor.tests.test_cmor_run_subtool_cmip7_further_examples module
      • test_case_cmip7()
    • fremor.tests.test_cmor_run_subtool_further_examples module
      • test_case_cmip6()
    • fremor.tests.test_cmor_tripolar module
      • TestLoadTripolarGrid
    • fremor.tests.test_cmor_yamler_freq_validation module
      • test_conv_mip_to_bronx_freq_case_sensitivity()
      • test_conv_mip_to_bronx_freq_edge_cases()
      • test_conv_mip_to_bronx_freq_invalid_frequency()
      • test_conv_mip_to_bronx_freq_valid_frequencies()
    • fremor.tests.test_cmor_yamler_subtool module
      • test_cmip6_freq_none_derivation_exception_caught()
      • test_cmip6_freq_none_derivation_succeeds()
      • test_cmip6_freq_none_no_derivation_raises()
      • test_cmip7_freq_none_raises()
      • test_cmor_yaml_subtool_dry_run_false()
      • test_dry_run_prints_cli_call()
      • test_dry_run_prints_python_call()
      • test_exp_json_does_not_exist()
      • test_gridding_dict_has_none_value_raises()
      • test_mip_table_file_does_not_exist()
      • test_outdir_creation_failure_raises_oserror()
      • test_outdir_creation_when_missing()
      • test_pp_dir_does_not_exist()
      • test_start_stop_calendar_missing_from_yaml()
      • test_table_dir_does_not_exist()
      • test_yamlfile_does_not_exist()
      • yamler_env()
  • Module contents

Submodules

• fremor.cli module
  • fremor CLI entry point: fremor
• fremor.cmor_config module
  • fremor config: YAML Generator
    • Functions
  • cmor_config_subtool()
• fremor.cmor_constants module
  • fremor Constants: Centralized Module-Wide Config
    • Sections
• fremor.cmor_finder module
  • fremor find and fremor varlist
    • Functions
    • Notes
  • cmor_find_subtool()
  • make_simple_varlist()
  • print_var_content()
• fremor.cmor_helpers module
  • fremor: helper/utility python functions
    • Functions
    • Notes
  • calendars_are_equivalent()
  • 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_time_calendar_value()
  • get_vertical_dimension()
  • iso_to_bronx_chunk()
  • normalize_calendar()
  • print_data_minmax()
  • update_calendar_type()
  • update_grid_and_label()
• fremor.cmor_init module
  • fremor init: CMOR config initialization
    • Trusted sources
    • Functions
  • cmor_init_subtool()
• fremor.cmor_mixer module
  • fremor run
    • Functions
  • cmor_run_subtool()
  • cmorize_all_variables_in_dir()
  • cmorize_target_var_files()
  • rewrite_netcdf_file_var()
• fremor.cmor_resolver module
  • fremor resolve: model-YAML resolver
  • resolve_fremor_yaml()
• fremor.cmor_tripolar module
  • fremor: tripolar ocean grid helpers
    • Functions
    • Notes
  • load_tripolar_grid()
• fremor.cmor_yamler module
  • fremor yaml: YAML-Driven CMORization Workhorse
    • Functions
  • cmor_yaml_subtool()

Module contents

fremor: CMORization for FRE output

This module provides routines which rewrite post-processed FRE/FMS model output in a community-driven, standardized way. This module relies heavily on PCMDI’s CMOR module and it’s python API. It is the core implementation for fremor run operations- mixing and matching GFDL’s and FRE’s conventions to CMOR’s expectations, so that participation in model-intercomparison projects may be eased. For more usage details, see the project README.md, the FRE documentation at https://noaa-gfdl.readthedocs.io/projects/fre-cli/en/latest/, PCMDI’s CMOR module documentation at https://cmor.llnl.gov/, and of course fremor’s documentation at https://fremor.readthedocs.io/en/stable/.

Note

this text is set by fremor/__init__.py’s docstring. Importing fremor sets the version attribute, and sets up a fre_logger