Utils#

Module Contents#

`convert_bool_to_emoji`	If value is boolean, convert to Green Checkmark or Red X. Otherwise, leave be.
`filter_lmp_locations`	Filters dataframe by locations, which can be a list, "ALL" or None
`format_interconnection_df`	Format interconnection queue data
`get_interconnection_queues`	Get interconnection queue data for all ISOs
`get_iso`	Get an ISO by its id
`get_zip_file`
`is_dst_end`
`is_today`
`is_within_last_days`	Returns whether date is within N days
`list_isos`	List available ISOs
`load_folder`	Load a single dataframe for same schema csv files in a folder
`make_availability_df`
`make_availability_table`
`make_lmp_availability_df`
`make_lmp_availability_table`

gridstatus.utils.convert_bool_to_emoji(value)[source]#: If value is boolean, convert to Green Checkmark or Red X. Otherwise, leave be.

gridstatus.utils.filter_lmp_locations(df, locations)[source]#

Filters dataframe by locations, which can be a list, “ALL” or None

Parameters:: df: pd.DataFrame locations: “ALL” or list of locations to filter “Location” column by

gridstatus.utils.format_interconnection_df(queue, rename, extra=None, missing=None)[source]#: Format interconnection queue data

gridstatus.utils.get_interconnection_queues()[source]#: Get interconnection queue data for all ISOs

gridstatus.utils.is_within_last_days(date, days, tz=None)[source]#: Returns whether date is within N days

gridstatus.utils.load_folder(path, time_zone=None, verbose=True)[source]#

Load a single dataframe for same schema csv files in a folder

Arguments:: path {str} – path to folder time_zone {str} – time zone to localize to timestamps. By default returns as UTC
Returns:: pd.DataFrame – dataframe of all files