energy_data_retrieval.sources.ons.client#
Brazil ONS generation and per-plant solar/wind constrained-off observations.
- energy_data_retrieval.sources.ons.client.parse_generation_csv(payload, *, product='generation', source_timezone='America/Sao_Paulo', include_estimates=False, maximum_rows=1000000)[source]#
Parse native semicolon CSV while retaining every native column.
Timestamps are native reference labels in the supplied source timezone. The default interprets them as Brazilian civil time, with ambiguous historical DST labels rejected. Callers with evidence for a fixed clock may specify
Etc/GMT+3. Type III and small-plant/MMGD estimates are excluded by default. Solar/wind detail keeps resource flags, estimated MW, actual MW and reference MW separate.- Parameters:
payload (str)
product (str)
source_timezone (str)
include_estimates (bool)
maximum_rows (int)
- Return type:
DataFrame
- class energy_data_retrieval.sources.ons.client.ONSClient(http, maximum_requests=25, maximum_rows=1000000)[source]#
Bases:
objectDiscover exact public monthly/yearly exports through ONS’s CKAN catalogue.
- Parameters:
http (HTTPClient)
maximum_requests (int)
maximum_rows (int)
- http: HTTPClient#
- maximum_requests: int#
- maximum_rows: int#
- generation(start, end, *, plant_ids=None, source_timezone='America/Sao_Paulo', include_estimates=False)[source]#
Retrieve inclusive local dates from hourly verified-generation exports.
- Parameters:
start (date)
end (date)
plant_ids (list[str] | None)
source_timezone (str)
include_estimates (bool)
- Return type:
- solar_curtailment(start, end, *, plant_ids=None, source_timezone='America/Sao_Paulo')[source]#
Retrieve half-hour PV detail, retaining actual/reference values and flags.
- Parameters:
start (date)
end (date)
plant_ids (list[str] | None)
source_timezone (str)
- Return type: