Timeseries

class enflow.assets.timeseries.ElectricityDemand(location: energydatamodel.geospatial.GeoLocation | None = None, *, name: str | None = None, df: pandas.core.frame.DataFrame | None = None, column_names: str | int | Tuple[str] | Tuple[int] | NoneType = None, filename: str | None = None)

Bases: TimeSeries

location: GeoLocation | None = None

column_names: str | int | Tuple[str] | Tuple[int] | None = None

df: DataFrame | None = None

filename: str | None = None

geometry_to_geojson(geometry)

get_data() → Series

Get data from TimeSeries as a pandas.Series.

Returns:

The time series data.

name: str | None = None

plot(start_date: str | DatetimeIndex, end_date: str | DatetimeIndex) → Axes

Plots a pandas Series using its built-in plot method.

Args:

start_date: The start date for the plot. end_date: The end date for the plot.

Returns:

The Matplotlib Axes object of the plot.

to_dataframe()

Convert data class to a pandas DataFrame.

to_geojson(exclude_none=True)

to_json(include_none: bool = False) → str

enflow.assets.timeseries.ElectricityConsumption

alias of ElectricityDemand

class enflow.assets.timeseries.ElectricityAreaDemand(area: energydatamodel.geospatial.GeoPolygon | energydatamodel.geospatial.GeoMultiPolygon | NoneType = None, *, name: str | None = None, df: pandas.core.frame.DataFrame | None = None, column_names: str | int | Tuple[str] | Tuple[int] | NoneType = None, filename: str | None = None)

Bases: TimeSeries

area: GeoPolygon | GeoMultiPolygon | None = None

column_names: str | int | Tuple[str] | Tuple[int] | None = None

df: DataFrame | None = None

filename: str | None = None

geometry_to_geojson(geometry)

get_data() → Series

Get data from TimeSeries as a pandas.Series.

Returns:

The time series data.

name: str | None = None

plot(start_date: str | DatetimeIndex, end_date: str | DatetimeIndex) → Axes

Plots a pandas Series using its built-in plot method.

Args:

start_date: The start date for the plot. end_date: The end date for the plot.

Returns:

The Matplotlib Axes object of the plot.

to_dataframe()

Convert data class to a pandas DataFrame.

to_geojson(exclude_none=True)

to_json(include_none: bool = False) → str

enflow.assets.timeseries.ElectricityAreaConsumption

alias of ElectricityAreaDemand

class enflow.assets.timeseries.ElectricitySupply(location: energydatamodel.geospatial.GeoLocation | None = None, *, name: str | None = None, df: pandas.core.frame.DataFrame | None = None, column_names: str | int | Tuple[str] | Tuple[int] | NoneType = None, filename: str | None = None)

Bases: TimeSeries

location: GeoLocation | None = None

column_names: str | int | Tuple[str] | Tuple[int] | None = None

df: DataFrame | None = None

filename: str | None = None

geometry_to_geojson(geometry)

get_data() → Series

Get data from TimeSeries as a pandas.Series.

Returns:

The time series data.

name: str | None = None

plot(start_date: str | DatetimeIndex, end_date: str | DatetimeIndex) → Axes

Plots a pandas Series using its built-in plot method.

Args:

start_date: The start date for the plot. end_date: The end date for the plot.

Returns:

The Matplotlib Axes object of the plot.

to_dataframe()

Convert data class to a pandas DataFrame.

to_geojson(exclude_none=True)

to_json(include_none: bool = False) → str

enflow.assets.timeseries.ElectricityProduction

alias of ElectricitySupply

class enflow.assets.timeseries.ElectricityAreaSupply(area: energydatamodel.geospatial.GeoPolygon | energydatamodel.geospatial.GeoMultiPolygon | NoneType = None, *, name: str | None = None, df: pandas.core.frame.DataFrame | None = None, column_names: str | int | Tuple[str] | Tuple[int] | NoneType = None, filename: str | None = None)

Bases: TimeSeries

area: GeoPolygon | GeoMultiPolygon | None = None

column_names: str | int | Tuple[str] | Tuple[int] | None = None

df: DataFrame | None = None

filename: str | None = None

geometry_to_geojson(geometry)

get_data() → Series

Get data from TimeSeries as a pandas.Series.

Returns:

The time series data.

name: str | None = None

plot(start_date: str | DatetimeIndex, end_date: str | DatetimeIndex) → Axes

Plots a pandas Series using its built-in plot method.

Args:

start_date: The start date for the plot. end_date: The end date for the plot.

Returns:

The Matplotlib Axes object of the plot.

to_dataframe()

Convert data class to a pandas DataFrame.

to_geojson(exclude_none=True)

to_json(include_none: bool = False) → str

enflow.assets.timeseries.ElectricityAreaProduction

alias of ElectricityAreaSupply

class enflow.assets.timeseries.HeatingDemand(location: energydatamodel.geospatial.GeoLocation | None = None, *, name: str | None = None, df: pandas.core.frame.DataFrame | None = None, column_names: str | int | Tuple[str] | Tuple[int] | NoneType = None, filename: str | None = None)

Bases: TimeSeries

location: GeoLocation | None = None

column_names: str | int | Tuple[str] | Tuple[int] | None = None

df: DataFrame | None = None

filename: str | None = None

geometry_to_geojson(geometry)

get_data() → Series

Get data from TimeSeries as a pandas.Series.

Returns:

The time series data.

name: str | None = None

plot(start_date: str | DatetimeIndex, end_date: str | DatetimeIndex) → Axes

Plots a pandas Series using its built-in plot method.

Args:

start_date: The start date for the plot. end_date: The end date for the plot.

Returns:

The Matplotlib Axes object of the plot.

to_dataframe()

Convert data class to a pandas DataFrame.

to_geojson(exclude_none=True)

to_json(include_none: bool = False) → str

enflow.assets.timeseries.HeatingConsumption

alias of HeatingDemand

class enflow.assets.timeseries.HeatingAreaDemand(area: energydatamodel.geospatial.GeoPolygon | energydatamodel.geospatial.GeoMultiPolygon | NoneType = None, *, name: str | None = None, df: pandas.core.frame.DataFrame | None = None, column_names: str | int | Tuple[str] | Tuple[int] | NoneType = None, filename: str | None = None)

Bases: TimeSeries

area: GeoPolygon | GeoMultiPolygon | None = None

column_names: str | int | Tuple[str] | Tuple[int] | None = None

df: DataFrame | None = None

filename: str | None = None

geometry_to_geojson(geometry)

get_data() → Series

Get data from TimeSeries as a pandas.Series.

Returns:

The time series data.

name: str | None = None

plot(start_date: str | DatetimeIndex, end_date: str | DatetimeIndex) → Axes

Plots a pandas Series using its built-in plot method.

Args:

start_date: The start date for the plot. end_date: The end date for the plot.

Returns:

The Matplotlib Axes object of the plot.

to_dataframe()

Convert data class to a pandas DataFrame.

to_geojson(exclude_none=True)

to_json(include_none: bool = False) → str