preheat_open.helpers

Various helper functions

Functions

DISPLAY_DEVELOPER_WARNING()

Method used for development purposes to decide whether to show warnings for development

check_no_remaining_fields(d, debug_helper)

Helper to check for empty kwargs (to ensure adequate propagation)

convenience_result_list_shortener(result)

Method used for convenience helpers to querying methods returning lists

datetime_convert(param)

Converts a time-related input to a valid datetime input for other methods

list_to_string(list2use[, separator])

Helper function to turn list into string, e.g.

now([step, tz])

Method to determine now time (and round it to the current step start if required)

sanitise_datetime_input(t)

rtype:

datetime

sanitise_unit_type_input(x)

Convenience function to fix specific unit types with unfortunate names in API

time_resolution_aliases(resolution)

Converts a resolution input to the corresponding pandas alias

timestep_start(step, t)

Computes the start of the current timestep