fre.pp package

Subpackages

• fre.pp.tests package
  • Submodules
    • fre.pp.tests.test_configure_script_yaml module
      • test_cleanup()
      • test_combinedyaml_exists()
      • test_configure_script()
      • test_validate()
      • test_validate_fail()
    • fre.pp.tests.test_fre_pp_init module
      • test_make_workflow_name()
    • fre.pp.tests.test_histval_script module
      • test_histval()
      • test_setup_histval()
    • fre.pp.tests.test_nccheck_script module
      • test_nccheck()
      • test_setup_nccheck()
    • fre.pp.tests.test_ppval_script module
      • create_4xdaily_file()
      • test_ppval()
      • test_ppval_4xdaily()
      • test_setup_ppval()
    • fre.pp.tests.test_rose_quoting module
      • test_boolean()
      • test_list()
      • test_string()
    • fre.pp.tests.test_split_netcdf module
      • test_split_file_cleanup()
      • test_split_file_data()
      • test_split_file_metadata()
      • test_split_file_run()
      • test_split_file_setup()
    • fre.pp.tests.test_split_netcdf_regex module
      • generate_regex()
      • test_split_netcdf_file_regex_pattern()
  • 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

fre.pp.make_workflow_name(experiment: str | None = None, platform: str | None = None, target: str | None = None) → str

Function that takes in a triplet of tags for a model experiment, platform, and target, and returns a directory name for the corresponding pp workflow. Because this is often given by user to the shell being used by python, we split/reform the string to remove semi-colons or spaces that may be used to execute an arbitrary command with elevated privileges.

Parameters:

• experiment (str) – One of the postprocessing experiment names from the yaml displayed by fre list exps -y $yamlfile (e.g. c96L65_am5f4b4r0_amip), default None

• platform (str) – The location + compiler that was used to run the model (e.g. gfdl.ncrc5-deploy), default None

• target (str) – Options used for the model compiler (e.g. prod-openmp), default None

Returns:

string created in specific format from the input strings

Return type:

str

Note

if any arguments are None, then “None” will appear in the workflow name