OpenNEM Package

Subpackages

• opennem.core package
  • Submodules
  • opennem.core.datas module
  • opennem.core.endpoint module
    • EndpointType
      • EndpointType.api
      • EndpointType.data
    • get_opennem_endpoint()
  • opennem.core.environment module
    • EnvironmentNotFound
    • get_environment()
  • opennem.core.intervals module
  • opennem.core.offsets module
    • delta_from_human_interval()
  • opennem.core.periods module
  • Module contents
• opennem.schema package
  • Submodules
  • opennem.schema.core module
    • BaseConfig
      • BaseConfig.Config
    • PropertyBaseModel
      • PropertyBaseModel.dict()
      • PropertyBaseModel.get_properties()
  • opennem.schema.dataset module
    • OpennemData
      • OpennemData.code
      • OpennemData.data_type
      • OpennemData.forecast
      • OpennemData.fuel_tech
      • OpennemData.history
      • OpennemData.id
      • OpennemData.interval
      • OpennemData.network
      • OpennemData.period
      • OpennemData.region
      • OpennemData.type
      • OpennemData.units
      • OpennemData.x_capacity_at_present
    • OpennemDataHistory
      • OpennemDataHistory.data
      • OpennemDataHistory.interval
      • OpennemDataHistory.last
      • OpennemDataHistory.start
      • OpennemDataHistory.values()
    • OpennemDataSet
      • OpennemDataSet.code
      • OpennemDataSet.created_at
      • OpennemDataSet.data
      • OpennemDataSet.get_by_network_id()
      • OpennemDataSet.get_by_network_region()
      • OpennemDataSet.get_by_stat_type()
      • OpennemDataSet.get_by_year()
      • OpennemDataSet.get_by_years()
      • OpennemDataSet.get_id()
      • OpennemDataSet.network
      • OpennemDataSet.region
      • OpennemDataSet.type
      • OpennemDataSet.version
  • opennem.schema.envs module
    • Environment
      • Environment.development
      • Environment.local
      • Environment.production
      • Environment.staging
  • opennem.schema.interval module
    • TimeInterval
      • TimeInterval.human
      • TimeInterval.interval
  • opennem.schema.network module
    • FacilityStatusSchema
      • FacilityStatusSchema.code
      • FacilityStatusSchema.label
    • FueltechSchema
      • FueltechSchema.code
      • FueltechSchema.label
      • FueltechSchema.renewable
    • NetworkRegionSchema
      • NetworkRegionSchema.code
      • NetworkRegionSchema.timezone
    • NetworkSchema
      • NetworkSchema.code
      • NetworkSchema.country
      • NetworkSchema.interval_size
      • NetworkSchema.label
      • NetworkSchema.regions
      • NetworkSchema.timezone
  • opennem.schema.period module
    • TimePeriod
      • TimePeriod.human
      • TimePeriod.period
  • opennem.schema.stat module
    • StatType
      • StatType.energy
      • StatType.gov
      • StatType.interchange
      • StatType.power
  • opennem.schema.validators module
    • chop_microseconds()
    • data_validate()
    • number_output()
    • optionally_parse_string_datetime()
    • optionaly_lowercase_string()
  • Module contents
• opennem.settings package
  • Submodules
  • opennem.settings.log module
    • SettingsNotFound
    • load_logging_config()
  • opennem.settings.schema module
    • OpennemSettings
      • OpennemSettings.Config
      • OpennemSettings.db_debug
      • OpennemSettings.debug
      • OpennemSettings.endpoint
      • OpennemSettings.env
      • OpennemSettings.http_cache_local
      • OpennemSettings.http_retries
      • OpennemSettings.http_timeout
      • OpennemSettings.log_level
      • OpennemSettings.precision_default
      • OpennemSettings.requests_cache_path
      • OpennemSettings.validate_log_level()
  • opennem.settings.utils module
    • load_env_file()
  • Module contents
• opennem.utils package
  • Submodules
  • opennem.utils.http module
    • TimeoutHTTPAdapter
      • TimeoutHTTPAdapter.send()
    • setup_http_cache()
  • opennem.utils.version module
    • VersionPart
      • VersionPart.MAJOR
      • VersionPart.MINOR
      • VersionPart.PATCH
    • get_pkg_version()
    • get_project_meta()
    • get_version()
  • Module contents

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) → 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[FueltechSchema]

Return fueltechs.

network_regions(network_id: str) → List[NetworkRegionSchema]

Return network regions.

networks() → List[NetworkSchema]

Return networks.

power_network_fueltech(network_id: str, network_region_code: str) → 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) → 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