OpenNEM Package

Submodules

opennem.cli module

opennem.client module

OpenNEM API Client Library.

Define the primary API client class for accessing API and data methods of OpenNEM.

class opennem.client.OpenNEMClient(base_url: Optional[str] = None)

Bases: object

OpenNEM Core API Client.

Access API endpoints with an instance of the API client

emission_factors(network_id: str)opennem.schema.dataset.OpennemDataSet

Get last 7 days of 30 minute emission factors for a network.

Parameters

network_id (str) – The network code

Raises

Exception – Base response

Returns

The data set in OpenNEM Data Set format.

Return type

OpennemDataSet

fueltechs()List[opennem.schema.network.FueltechSchema]

Return fueltechs.

network_regions(network_id: str)List[opennem.schema.network.NetworkRegionSchema]

Return network regions.

networks()List[opennem.schema.network.NetworkSchema]

Return networks.

power_network_fueltech(network_id: str, network_region_code: str)opennem.schema.dataset.OpennemDataSet

Get last 7 days of power generation per fueltech.

Parameters
  • network_id (str) – The network code

  • network_region_code – The network region code

Raises

Exception – Base response

Returns

The data set in OpenNEM Data Set format.

Return type

OpennemDataSet

price(network_id: str)opennem.schema.dataset.OpennemDataSet

Get price for a network.

Parameters

network_id (str) – The network code

Raises

Exception – Base response

Returns

The data set in OpenNEM Data Set format.

Return type

OpennemDataSet

class opennem.client.OpenNEMStats(opennem_client)

Bases: object

OpenNEM Stats Client.

Module contents

OpenNEM Python Client Library