Base

Bases: AbstractClass

Get data from :class: TimeSeries

name: str | None = None

location: GeoLocation | None = None

latitude: float | None = None

longitude: float | None = None

altitude: float | None = None

tz: timezone | None = None

timeseries: TimeSeries | None = None

get_location()[source]

plot_timeseries(start_date: str | DatetimeIndex | None = None, end_date: str | DatetimeIndex | None = None) → Axes[source]

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.

geometry_to_geojson(geometry)

to_dataframe(): Convert data class to a pandas DataFrame.

to_geojson(exclude_none=True)

to_json(include_none: bool = False) → str

Bases: AbstractClass

name: str | None = None

df: DataFrame | None = None

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

filename: str | None = None

get_data() → Series[source]

Get data from TimeSeries as a pandas.Series.

Returns:: The time series data.

plot(start_date: str | DatetimeIndex, end_date: str | DatetimeIndex) → Axes[source]

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.

geometry_to_geojson(geometry)

to_dataframe(): Convert data class to a pandas DataFrame.

to_geojson(exclude_none=True)

to_json(include_none: bool = False) → str

class enflow.assets.base.Sensor(*, name: str | None = None, location: energydatamodel.geospatial.GeoLocation | None = None)[source]

Bases: AbstractClass

name: str | None = None

location: GeoLocation | None = None

geometry_to_geojson(geometry)

to_dataframe(): Convert data class to a pandas DataFrame.

to_geojson(exclude_none=True)

to_json(include_none: bool = False) → str

class enflow.assets.base.EnergyCollection(*, name: str | None = None, assets: ~typing.List[~energydatamodel.base.EnergyAsset] | None = <factory>, collections: ~typing.List[~energydatamodel.base.EnergyCollection] | None = <factory>)[source]

Bases: AbstractClass

EnergySystem base class.

name: str | None = None

assets: List[EnergyAsset] | None

collections: List[EnergyCollection] | None

add_assets(assets: EnergyAsset | List[EnergyAsset])[source]

remove_asset(asset: EnergyAsset)[source]

list_assets()[source]

add_collection(collection: EnergyCollection)[source]

list_collections()[source]

remove_collection(collection: EnergyCollection)[source]

get_asset_by_name(name: str)[source]

to_tree(only_named=True, show_type=False, return_tree=False)[source]

geometry_to_geojson(geometry)

to_dataframe(): Convert data class to a pandas DataFrame.

to_geojson(exclude_none=True)

to_json(include_none: bool = False) → str