Utilities

Utilities.check_dict_for_nans(dictionary)
Utilities.dict_to_yaml(dictionary_to_write, yaml_filename, merge_with_existing=False, verbose=False)

Write an input dictionary to a YAML file.

This function takes an input dictionary and writes it directly to a YAML file, preserving any nesting and keyname relationships. For example an input dictionary:

input_dict = {'parent_1': {'a': 2, 'b': 3},
              'parent_2': {'a': 20, 'b': 30}}

will be translated into a YAML file with the same hierarchy:

parent_1:
  a: 2
  b: 3
parent_2:
  a: 20
  b: 30

This function also allows for the converted dictionary to be appended to an existing YAML file.

Parameters:

  • dictionary_to_write (dict, list(dict)) – The dictionary or a list of dictionaries to save as a YAML file.

  • yaml_filename (str) – The filename to use when saving the YAML file.

  • merge_with_existing (bool, optional) – A flag to specify that the yaml_filename already exists and the new values help in dictionary_to_write should be appended to this existing file rather than overwriting it. Defaults to False.

  • verbose (bool, optional) – A flag to print additional output, including the contents of the dictionary, after the conversion process. Defaults to False

Returns:

None

Utilities.get_host_computer()

Check if environment is running on the HPC.

This function queries an environment variable, NREL_CLUSTER and if the pattern “eagle” is found, sets the variable hpc_run to True to allow the submission CFD jobs from the Notebook. Note that the particular pattern “eagle” is found to correctly identify all instances of the Eagle HPC but may need to be updated to catch other HPC systems (e.g., Vermillion or Swift).

Parameters:

None –

Returns:

True if HPC resources identified, False otherwise.

Return type:

bool

Utilities.print_dict(dict_to_print, indent=0)

Neatly print a dictionary with indentation for nesting.

This function prints a dictionary with items visually indented according to their nesting. Multiple nesting and sub-nesting levels are supported.

Parameters:

  • dict_to_print (dict) – The dictionary to print. The dictionary entries can be sub-dictionaries which creates the nested structure.

  • indent (int, optional) – The indentation level to use at the root level of the dictionary. If not included, the default indentation of 0 is used. Non-zero values of indent effectively shift the output to the right.

Returns:

None

Utilities.yaml_to_dict(yaml_filename, verbose=False)

Read a YAML file and store as a dictionary.

This function reads an input YAML file and stores the contents as a Python dictionary, where all necessary relationships and keynames are preserved as shown in the YAML file.

Parameters:

  • yaml_filename (str) – The YAML filename to read the data from.

  • verbose (bool, optional) – A flag to print additional output, including the contents of the converted dictionary, after the conversion process. Defaults to False

Returns:

None