Utilities

Miscellaneous helper functions used internally and available for advanced users.

I/O Helpers

util.read_json(path)

util.read_yaml(path)

Time Series

util.get_common_timestep(data[, units, ...])

Get the most commonly occuring timestep of data as frequency string.

util.reindex_datetime(data[, file_name, report])

Find dataframe index frequency and reindex to add any missing intervals.

util.detect_solar_noon(data[, ghi_col, default])

Estimate a single representative solar-noon clock time from clear-sky GHI.

Irradiance

util.generate_irr_distribution(lowest_irr, ...)

Create a list of increasing values similar to POA irradiance data.

Column and Tag Operations

util.tags_by_regex(tag_list, regex_str)

util.append_tags(sel_tags, tags, regex_str)

util.get_agg_column_name(group_id, agg_func)

Generate a column name for an aggregated column.

Regression

util.parse_regression_formula(formula)

Return (lhs_list, rhs_list) for formula.

util.process_reg_cols(original_calc_params)

Recursively process a regression columns dictionary that includes calculated parameters.

util.transform_calc_params(node, cd[, ...])

Recursively transform a calc_params node, returning resolved values.

Configuration

util.update_by_path(dictionary, path[, ...])

Update a nested dictionary value by following a path list.