reVX.handlers.sc_points.Point

class Point(sc_gid, capacity, res_gids, gid_counts, gen_cf)

Bases: object

Class to handle single Supply Curve point

Parameters:

• sc_gid (int) – Supply curve point gid

• capacity (float) – Point capacity

• res_gids (list | str) – Resource gids associated with Supply curve point

• gid_counts (list | str) – Resource gid exclusion pixel counts

• gen_cf (ndarray) – Generation capacity factor means

Methods

create(sc_point, gen_cf_means)	Create Point from supply curve point meta and resource meta
extract_capacity(capacity)	Extract capacity from Supply Curve point in order of best resource gids (based on cf_mean)

Attributes

available_capacities	Capacity of available gids
available_res_gids	Index of available resource gids
capacity	Supply curve point capacity
cf_means	Capacity factor means for each resource gid
gid_counts	Resource gid exclusion pixel counts
resource_capacity	Capacity of resource gids
resource_gids	Resource gids associated with supply curve point
sc_gid	Supply curve point gid

property sc_gid

Supply curve point gid

Returns:

int

property capacity

Supply curve point capacity

Returns:

float

property resource_gids

Resource gids associated with supply curve point

Returns:

ndarray

property gid_counts

Resource gid exclusion pixel counts

Returns:

ndarray

property resource_capacity

Capacity of resource gids

Returns:

ndarray

property available_capacities

Capacity of available gids

Returns:

ndarray

property available_res_gids

Index of available resource gids

Returns:

ndarray

property cf_means

Capacity factor means for each resource gid

Returns:

ndarray

extract_capacity(capacity)

Extract capacity from Supply Curve point in order of best resource gids (based on cf_mean)

Parameters:

capacity (float) – Capacity to extract from Supply Curve point

Returns:

• sc_point (pd.Series) – Resource gids being allocated

• capacity (float) – Capacity being allocated

• availability (bool) – Whether Supply Curve point still has available capacity

classmethod create(sc_point, gen_cf_means)

Create Point from supply curve point meta and resource meta

Parameters:

• sc_point (pandas.Series) – Supply curve point meta data

• gen_cf_means (pandas.Series) – Generation cf_means indexed by “gen_gid”

Returns:

Point – Initialized Point objects