Full reference<a class="headerlink" href="#module-energyquantified" title="Permalink to this headline">¶

energyquantified.data.AbsoluteResult

class energyquantified.api.InstancesAPI(*args, **kwargs)¶

Instance API operations. Access these operations via an instance of the energyquantified.EnergyQuantified class:

>>> eq = EnergyQuantified(api_key="aaaa-bbbb-cccc-dddd")
>>> eq.instances.list(curve, tags)

absolute(curve, delivery, begin, end, frequency=None, time_zone=None, hour_filter=None, unit=None, aggregation=None, tags=None, exclude_tags=None)¶

Load forecasted values from various instances for a specific point in time, to see how forecasts develop over time.

The point in time is the datetime supplied to the delivery parameter. Choose the frequency of the delivery by providing the frequency parameter. If a frequency is not provided, it defaults to using the Curve’s frequency.

Loads forecasted values from instances issued between begin (inclusive) and end (exclusive).

Parameters

curve (energyquantified.metadata.Curve, str) – The curve or curve name
delivery (date, datetime, str, required) – The datetime to load forecasted values for. The frequency and time zone of the delivery defaults to the Curve’s frequency and instance zone, respectively, but can be changed by the frequency and time_zone parameters.
begin (date, datetime, str, required) – Earliest instance issued date-time (inclusive)
end (date, datetime, str, required) – Latest instance issued date-time (exclusive)
frequency (Frequency, optional) – Aggregate the delivery to a lower frequency than the Curve’s frequency. Defaults to None, which keeps the result in the Curve’s frequency.
time_zone (TzInfo, optional) – Timezone of the delivery. Defaults to the Curve’s instance zone.
hour_filter (Filter, optional) – Filter on hours to include (i.e. BASE, PEAK), has no effect unless frequency is provided. Defaults to BASE.
unit (str, optional) – Convert unit of the data. Defaults to using the Curve’s unit.
aggregation (Aggregation, optional) – The aggregation method (i.e. AVERAGE, MIN, MAX), has no effect unless frequency is provided. Defaults to AVERAGE.
tags (list, str, optional) – Filter instances by tags, excluding instances not matching any of the tags. Defaults to None, which does not filter.
exclude_tags (list, str, optional) – Filter instances by tags, excluding instances matching any of the tags.

Returns

An absolute result

Return type

get(curve, issued=None, tag='', time_zone=None, frequency=None, aggregation=None, hour_filter=None, threshold=None, ensembles=False, unit=None)¶

Get an instance specified by a issued (issue date) and tag. The default tag is blank and tags are case-insensitive.

Supports aggregation by specifying a frequency. Optionally, you can specify the aggregation method (default is average) and the hourly filter (base, peak, etc.).

This operation works for curves with curve_type = INSTANCE only.

Parameters

curve (energyquantified.metadata.Curve, str) – The curve or curve name
issued (datetime, date, str, optional) – The issue date-time, defaults to None
tag (str, optional) – The instance tag, defaults to “”
frequency (Frequency, optional) – Set the preferred frequency for aggregations, defaults to None
time_zone (TzInfo, optional) – Set the timezone for the date-times
aggregation (Aggregation, optional) – The aggregation method (i.e. AVERAGE, MIN, MAX), has no effect unless frequency is provided, defaults to AVERAGE
hour_filter (Filter, optional) – Filters on hours to include (i.e. BASE, PEAK), has no effect unless frequency is provided, defaults to BASE
threshold (int, optional) – Allow that many values to be missing within one frame of frequency. Has no effect unless frequency is provided, defaults to 0.
ensembles (bool, optional) – Whether to include ensembles where available, defaults to False
unit (str, optional) – Convert unit of data, defaults to curves unit

Returns

A time series instance

Return type

latest(curve, tags=None, issued_at_latest=None, time_zone=None, frequency=None, aggregation=None, hour_filter=None, threshold=None, ensembles=False, unit=None)¶

Get the latest time series instance with filtering on tags and issued_at_latest.

Supports aggregation by specifying a frequency. Optionally, you can specify the aggregation method (default is average) and the hourly filter (base, peak, etc.).

This operation works for curves with curve_type = INSTANCE only.

Parameters

curve (energyquantified.metadata.Curve, str) – The curve or curve name
tags (list, str, optional) – Filter by instance tags, defaults to None
issued_at_latest ([type], optional) – [description], defaults to None
time_zone (TzInfo, optional) – Set the timezone for the date-times
frequency (Frequency, optional) – Set the preferred frequency for aggregations, defaults to None
aggregation (Aggregation, optional) – The aggregation method (i.e. AVERAGE, MIN, MAX), has no effect unless frequency is provided, defaults to AVERAGE
hour_filter (Filter, optional) – Filters on hours to include (i.e. BASE, PEAK), has no effect unless frequency is provided, defaults to BASE
threshold (int, optional) – Allow that many values to be missing within one frame of frequency. Has no effect unless frequency is provided, defaults to 0.
ensembles (bool, optional) – Whether to include ensembles where available, defaults to False
unit (str, optional) – Convert unit of data, defaults to curves unit

Returns

A time series instance

Return type

list(curve, tags=None, exlude_tags=None, limit=25, issued_at_latest=None, issued_at_earliest=None)¶

List instances for the curve. Does not load any time series data.

Filter on the instance tags or exclude_tags (list of values allowed), or restrict the instance issue date by setting issued_at_latest and/or issued_at_earliest.

Limit the maximum number of returned instances by setting limit anywhere between 1 and 25.

This operation works for curves with curve_type = INSTANCE only.

Parameters

curve (energyquantified.metadata.Curve, str) – The curve or curve name
tags (list, str, optional) – Filter by instance tags, defaults to None
exlude_tags (list, str, optional) – Exclude instance tags, defaults to None
limit (int, optional) – Number of instances returned, defaults to 25
issued_at_latest (datetime, date, str, optional) – Filter by issue date, defaults to None
issued_at_earliest (datetime, date, str, optional) – Filter by issue date, defaults to None

Returns

A list of energyquantified.metadata.Instance

Return type

list

load(curve, tags=None, exlude_tags=None, limit=5, issued_at_latest=None, issued_at_earliest=None, time_zone=None, frequency=None, aggregation=None, hour_filter=None, threshold=None, ensembles=False, unit=None)¶

Load time series instances.

Filter on the instance tags or exclude_tags (list of values allowed), or restrict the instance issue date by setting issued_at_latest and/or issued_at_earliest.

When ensembles is False: Adjust the maximum number of returned time series instances by setting limit between 1 and 25.

When ensembles is True: limit must be between 1 and 10.

Supports aggregation by specifying a frequency. Optionally, you can specify the aggregation method (default is average) and the hourly filter (base, peak, etc.).

This operation works for curves with curve_type = INSTANCE only.

Parameters

curve (energyquantified.metadata.Curve, str) – The curve or curve name
tags (list, str, optional) – Filter by instance tags, defaults to None
exlude_tags (list, str, optional) – Exclude instance tags, defaults to None
limit (int, optional) – Maximum number of instances returned, defaults to 5
issued_at_latest ([type], optional) – [description], defaults to None
issued_at_earliest ([type], optional) – [description], defaults to None
time_zone (TzInfo, optional) – Set the timezone for the date-times
frequency (Frequency, optional) – Set the preferred frequency for aggregations, defaults to None
aggregation (Aggregation, optional) – The aggregation method (i.e. AVERAGE, MIN, MAX), has no effect unless frequency is provided, defaults to AVERAGE
hour_filter (Filter, optional) – Filters on hours to include (i.e. BASE, PEAK), has no effect unless frequency is provided, defaults to BASE
threshold (int, optional) – Allow that many values to be missing within one frame of frequency. Has no effect unless frequency is provided, defaults to 0.
ensembles (bool, optional) – Whether to include ensembles where available, defaults to False
unit (str, optional) – Convert unit of data, defaults to curves unit

Returns

A list energyquantified.data.Timeseries instances

Return type

list

relative(curve, begin=None, end=None, tag=None, days_ahead=1, issued='latest', time_of_day=None, after_time_of_day=None, before_time_of_day=None, modified_at_latest=None, time_zone=None, frequency=None, aggregation=None, hour_filter=None, threshold=None, unit=None)¶

Load one instance for each day based on some common criteria, stitch them together and return a continuous time series.

By default, this method selects the day-ahead instances (forecasts), but you can set days_ahead to 0 or higher. 0 means intraday, 1 means the day-ahead (default), 2 means the day after day-ahead, and so on.

You may control the time of the day the instance is issued by setting exactly one of the follow parameters: time_of_day, after_time_of_day or before_time_of_day. Additionally, you may control the time of the day the instance has been modified (or created if modified is null) by setting modified-at-latest. These should be set to a time (HH:MM:SS). You can use the datetime.time.

This operation works for curves with curve_type = INSTANCE only.

Parameters

curve (energyquantified.metadata.Curve, str) – The curve or curve name
begin (date, datetime, str, required) – The begin date-time
end (date, datetime, str, required) – The end date-time
days_ahead (int, optional) – The number of leading days (0 or higher), defaults to 1
issued (str, optional) – Whether to select the earliest or latest matching instance per day, allowed values “earliest” | “latest”, defaults to “earliest”
time_of_day (time, str, optional) – The exact time of the instance is issued, defaults to None
after_time_of_day (time, str, optional) – The instance must be issued at this time of day or after, defaults to None
before_time_of_day (time, str, optional) – The instance must be issued before this time of day, defaults to None
modified-at-latest (time, str, optional) – The instance must be modified (or created if modified is null) before this time of day, defaults to None
time_zone (TzInfo, optional) – Set the timezone for the date-times
frequency (Frequency, optional) – Set the preferred frequency for aggregations, defaults to None
aggregation (Aggregation, optional) – The aggregation method (i.e. AVERAGE, MIN, MAX), has no effect unless frequency is provided, defaults to AVERAGE
hour_filter (Filter, optional) – Filters on hours to include (i.e. BASE, PEAK), has no effect unless frequency is provided, defaults to BASE
threshold (int, optional) – Allow that many values to be missing within one frame of frequency. Has no effect unless frequency is provided, defaults to 0.
unit (str, optional) – Convert unit of data, defaults to curves unit

Returns

A time series

Return type

rolling(curve, begin, end, hours_ahead=0, tags=None, exclude_tags=None, time_zone=None, frequency=None, aggregation=None, hour_filter=None, threshold=None, unit=None)¶

Load a timeseries from begin to end, where each value is from the latest instance created at least hours_ahead before the datetime of the value.

Parameters

curve (energyquantified.metadata.Curve, str) – The curve or curve name
begin (date, datetime, str, required) – The begin date (inclusive) of the resulting timeseries
end (date, datetime, str, required) – The end date (exclusive) of the resulting timeseries
hours_ahead (int, optional) – The minimum number of hours between the created datetime of an instance and its values to be considered in the rolling forecast. Must be 0 at minimum and 24 at maximum. Defaults to 0
tags (list, str, optional) – Filter by instance tags, defaults to None
exclude_tags (list, str, optional) – Exclude instance tags, defaults to None
time_zone (TzInfo, optional) – Convert the timezone of the resulting series, defaults to None
frequency (Frequency, optional) – Set the preferred frequency for aggregations, defaults to None
aggregation (Aggregation, optional) – The aggregation method (i.e. AVERAGE, MIN, MAX). Has no effect unless frequency is provided. Defaults to AVERAGE.
hour_filter (Filter, optional) – Filters on hours to include (i.e. BASE, PEAK). Has no effect unless frequency is provided. Defaults to BASE.
threshold (_type_, optional) – Allow that many values to be missing within one frame of frequency. Has no effect unless frequency is provided, defaults to 0.
unit (str, optional) – Convert unit of data, defaults to the Curve’s unit

Returns

A time series instance

Return type

tags(curve)¶

Get all tags available for a curve.

This operation works for curves with curve_type = INSTANCE only.

Parameters: curve (energyquantified.metadata.Curve, str) – The curve or curve name
Returns: A set available tags for provded curve
Return type: set

class energyquantified.api.PeriodsAPI(*args, **kwargs)¶

Period-based series API operations. Access these operations via an instance of the energyquantified.EnergyQuantified class:

>>> eq = EnergyQuantified(api_key="aaaa-bbbb-cccc-dddd")
>>> eq.periods.load(curve, begin, end)

load(curve, begin=None, end=None, time_zone=None, unit=None)¶

Load period-based series data for a curve.

This operation works for curves with curve_type = PERIOD only.

Parameters

curve (energyquantified.metadata.Curve, str) – The curve or curve name
begin (date, datetime, str, required) – The begin date-time
end (date, datetime, str, required) – The end date-time
time_zone (TzInfo, optional) – Set the timezone for the date-times
unit (str, optional) – Convert unit of data, defaults to curves unit

Returns

A period-based series

Return type

class energyquantified.api.PeriodInstancesAPI(*args, **kwargs)¶

Period-based series instances API operations. Access these operations via an instance of the energyquantified.EnergyQuantified class:

>>> eq = EnergyQuantified(api_key="aaaa-bbbb-cccc-dddd")
>>> eq.period_instances.load(curve, begin, end)

get(curve, begin=None, end=None, issued=None, tag='', time_zone=None, unit=None)¶

Get a specific period-based series instance.

Parameters

curve (energyquantified.metadata.Curve, str) – The curve or curve name
begin (date, datetime, str, required) – The begin date-time
end (date, datetime, str, required) – The end date-time
issued (datetime, date, str, required) – The instance issue date
tag (str, required) – The instance tag
time_zone (TzInfo, optional) – Set the timezone for the date-times
unit (str, optional) – Convert unit of data, defaults to curves unit

Returns

A period-based series

Return type

latest(curve, begin=None, end=None, issued_at_latest=None, time_zone=None, unit=None)¶

Get the latest period-based series instance.

This operation works for curves with curve_type = INSTANCE_PERIOD only.

Parameters

curve (energyquantified.metadata.Curve, str) – The curve or curve name
begin (date, datetime, str, required) – The begin date-time
end (date, datetime, str, required) – The end date-time
issued_at_latest (date, datetime, str, optional) – The latest issue date for the loaded instance, defaults to None
time_zone (TzInfo, optional) – Set the timezone for the date-times
unit (str, optional) – Convert unit of data, defaults to curves unit

Returns

A period-based series

Return type

list(curve, tags=None, exlude_tags=None, limit=20, issued_at_latest=None, issued_at_earliest=None)¶

List instances for the curve. Does not lad any period-based series.

Filter on the instance tags or exclude_tags (list of values allowed), or restrict the instance issue date by setting issued_at_latest and/or issued_at_earliest.

Limit the maximum number of returned instances by setting limit anywhere between 1 and 20.

This operation works for curves with curve_type = INSTANCE_PERIOD only.

Parameters

curve (energyquantified.metadata.Curve, str) – The curve or curve name
tags (list, str, optional) – Filter by instance tags, defaults to None
exlude_tags (list, str, optional) – Exclude instance tags, defaults to None
limit (int, optional) – Number of instances returned, defaults to 25
issued_at_latest (datetime, date, str, optional) – Filter by issue date, defaults to None
issued_at_earliest (datetime, date, str, optional) – Filter by issue date, defaults to None

Returns

A list of energyquantified.metadata.Instance

Return type

list

load(curve, begin=None, end=None, tags=None, exlude_tags=None, limit=3, issued_at_latest=None, issued_at_earliest=None, time_zone=None, unit=None)¶

Load period-based series instances.

Filter on the instance tags or exclude_tags (list of values allowed), or restrict the instance issue date by setting issued_at_latest and/or issued_at_earliest.

This operation works for curves with curve_type = INSTANCE_PERIOD only.

Parameters

curve (energyquantified.metadata.Curve, str) – The curve or curve name
begin (date, datetime, str, required) – The begin date-time
end (date, datetime, str, required) – The end date-time
tags (list, str, optional) – Filter by instance tags, defaults to None
exlude_tags (list, str, optional) – Exclude instance tags, defaults to None
limit (int, optional) – Number of instances returned, defaults to 3
issued_at_latest (datetime, date, str, optional) – Filter by issue date, defaults to None
issued_at_earliest (datetime, date, str, optional) – Filter by issue date, defaults to None
time_zone (TzInfo, optional) – Set the timezone for the date-times
unit (str, optional) – Convert unit of data, defaults to curves unit

Returns

List of energyquantified.data.Periodseries objects

Return type

list

relative(curve, begin=None, end=None, days_ahead=None, before_time_of_day=None, time_zone=None, unit=None)¶

Loads period-based series instances n days-ahead and stitches them together to a single, continuous period series.

This operation is useful for loading historical day-ahead forecasts.

Parameters

curve (energyquantified.metadata.Curve, str) – The curve or curve name
begin (date, datetime, str, required) – The begin date-time
end (date, datetime, str, required) – The end date-time
days_ahead (int, required) – The n days ahead of the instance’s issue date. days-head = 0 means intraday forecasts, days-ahead = 1 means day-ahead, days-ahead = 2 means the day after day-ahead, and so on.
before_time_of_day (time, str, optional) – The time of day to load the instance, defaults to None
time_zone (TzInfo, optional) – Set the timezone for the date-times
unit (str, optional) – Convert unit of data, defaults to curves unit

Returns

A period-based series

Return type

energyquantified.data.OHLCList

class energyquantified.api.OhlcAPI(client)¶

Operations for OHLC data retrieval. Access these operations via an instance of the energyquantified.EnergyQuantified class:

>>> eq = EnergyQuantified(api_key="aaaa-bbbb-cccc-dddd")
>>> eq.ohlc.load(curve, begin, end)

latest(curve, date=None, unit=None)¶

Select all OHLC for specific trading day, while defaulting to the latest available OHLC data.

If date is given, this method will try to fetch OHLC data for that trading day. When there is no data for the given day, OHLC data will be loaded for the closest trading day earlier in time with data.

This operation works for curves with curve_type = OHLC only.

Parameters

curve (energyquantified.metadata.Curve, str) – The curve or curve name
date (date, str, required) – The trading date, defaults to today
unit (str, optional) – Convert unit of data, defaults to curves unit

Returns

A list of OHLC objects

Return type

latest_as_periods(curve, field=SETTLEMENT, date=None, time_zone=None, unit=None)¶

Load all OHLC rows from a single trading day, sort them, and merge/convert them to a continuous series.

It defaults to using the latest prices available, therefore “latest_as_period”.

If date is given, this method will try to fetch OHLC data for that trading day. When there is no data for the given day, OHLC data will be loaded for the closest trading day earlier in time with data.

By default, this method uses the settlement price. Select another field, such as close price, by setting the field parameter.

This operation works for curves with curve_type = OHLC only.

Parameters

curve (energyquantified.metadata.Curve, str) – The curve or curve name
field (OHLCField, str, optional) – The field to generate the series from, defaults to OHLCField.SETTLEMENT
date (date, str, required) – The trading date, defaults to today
time_zone (TzInfo, optional) – Set the timezone for the date-times
unit (str, optional) – Convert unit of data, defaults to curves unit

Returns

A period-based series

Return type

energyquantified.data.OHLCList

load(curve, begin=None, end=None, period=None, delivery=None, front=None, unit=None)¶

Load OHLC data for a energyquantified.metadata.Curve.

This operation works for curves with curve_type = OHLC only.

Parameters

curve (energyquantified.metadata.Curve, str) – The curve or curve name
begin (date, str, required) – The begin date
end (date, str, required) – The end date
period (ContractPeriod, str, optional) – Filter on contract period (day, week, month etc.), defaults to None
delivery (date, str, optional) – Filter on delivery date, requires parameter period to be set; cannot be used together with front, defaults to None
front (int, optional) – Filter on front contract, requires parameter period to be set; cannot be used together with delivery, defaults to None
unit (str, optional) – Convert unit of data, defaults to curves unit

Returns

A list of OHLC objects

Return type

load_delivery_as_timeseries(curve, begin=None, end=None, period=None, delivery=None, field=SETTLEMENT, fill=None, unit=None)¶

Load historical OHLC data for specific contract, and convert it to a energyquantified.data.Timeseries.

Defaults to use the settlement field, but you can select any field you want. All other parameters are required.

This operation works for curves with curve_type = OHLC only.

Parameters

curve (energyquantified.metadata.Curve, str) – The curve or curve name
begin (date, str, required) – The begin date
end (date, str, required) – The end date
period (ContractPeriod, str, required) – The contract period (week, month, quarter)
delivery (date, str, required) – The delivery date for the contract
field (OHLCField, str, required) – The field (close, settlement, etc.) to extract to a time series, defaults to OHLCField.SETTLEMENT
fill (str, optional) – How to handle days without trades. Allowed values are: no-fill do nothing, fill-holes fill in holes with data from previous trading day, forward-fill fill in all blanks with data from the previous trading day (also into the future). Defaults to no-fill.
unit (str, optional) – Convert unit of data, defaults to curves unit

Returns

A time series

Return type

load_front_as_timeseries(curve, begin=None, end=None, period=None, front=None, field=SETTLEMENT, fill=None, unit=None)¶

Load historical OHLC data for a continuous front contract, and convert it to a energyquantified.data.Timeseries.

Defaults to use the settlement field, but you can select any field you want. All other parameters are required.

This operation works for curves with curve_type = OHLC only.

Parameters

curve (energyquantified.metadata.Curve, str) – The curve or curve name
begin (date, str, required) – The begin date
end (date, str, required) – The end date
period (ContractPeriod, str, required) – The contract period (week, month, quarter)
front (int, required) – The front contract (1=front, 2=second front, etc.)
field (OHLCField, str, required) – The field (close, settlement, etc.) to extract to a time series, defaults to OHLCField.SETTLEMENT
fill (str, optional) – How to handle days without trades. Allowed values are: no-fill do nothing, fill-holes fill in holes with data from previous trading day, forward-fill fill in all blanks with data from the previous trading day (also into the future). Defaults to no-fill.
unit (str, optional) – Convert unit of data, defaults to curves unit

Returns

A time series

Return type

class energyquantified.api.SrmcAPI(client)¶

Operations for SRMC calculations in the API. Access these operations via an instance of the energyquantified.EnergyQuantified class:

>>> eq = EnergyQuantified(api_key="aaaa-bbbb-cccc-dddd")
>>> eq.srmc.load_front(curve, begin, end, period='month', front=1)

latest(curve, date=None, gas_therm_to_mwh=None, api2_tonne_to_mwh=None, carbon_emissions=None, efficiency=None, carbon_tax_area=None, unit=None)¶

Calculate short-run margincal costs (SRMC) for all settlement prices from a trading day. Defaults to using OHLC data from the latest available trading day, hence latest().

If date is given, this method will try to fetch OHLC data for that trading day. When there is no data for the given day, OHLC data will be loaded for the closest trading day earlier in time with data.

SRMC is calculated from a coal or gas curve of your choosing. It uses the daily reference rates from the European Central Bank (ECB) for currency conversions. The EUA price in the calculation is the settlement price from ICE.

Some countries, such as Great Britain, has an additional flat tax on carbon emissions. Specify the carbon_tax_area parameter to apply tax rules for a specific country.

This operation works for coal or gas curves with curve_type = OHLC only.

Parameters

curve (energyquantified.metadata.Curve, str) – The curve or curve name
date (date, str, required) – The trading date, defaults to today
gas_therm_to_mwh (float, optional) – Conversion from pence/therm to GBP/MWh (still in higher-heating value). Defaults to 0.029307.
api2_tonne_to_mwh (float, optional) – Conversion from API2 coal to MWh. Defaults to 6.978.
carbon_emissions (float, optional) – The carbon content as tCO2/MWh. This value varies between coal and gas. For coal, the default factor is 0.34056. For gas, the default factor is 0.202.
efficiency (float, optional) – The energy efficiency. For coal, the default factor is 0.42. For gas, the default factor is 0.59.
carbon_tax_area (Area, str, optional) – Set an area to apply tax rules for.
unit (str, optional) – Convert unit of data, defaults to curves unit

Returns

An SRMC object with a list of OHLC objects

Return type

latest_as_periods(curve, date=None, gas_therm_to_mwh=None, api2_tonne_to_mwh=None, carbon_emissions=None, efficiency=None, carbon_tax_area=None, time_zone=None, unit=None)¶

Calculate short-run margincal costs (SRMC) for all settlement prices from a trading day, sort them, and merge/convert them to a continuous series.

Defaults to using OHLC data from the latest available trading day, hence latest in the method name.

If date is given, this method will try to fetch OHLC data for that trading day. When there is no data for the given day, OHLC data will be loaded for the closest trading day earlier in time with data.

SRMC is calculated from a coal or gas curve of your choosing. It uses the daily reference rates from the European Central Bank (ECB) for currency conversions. The EUA price in the calculation is the settlement price from ICE.

Some countries, such as Great Britain, has an additional flat tax on carbon emissions. Specify the carbon_tax_area parameter to apply tax rules for a specific country.

This operation works for coal or gas curves with curve_type = OHLC only.

Parameters

curve (energyquantified.metadata.Curve, str) – The curve or curve name
date (date, str, required) – The trading date, defaults to today
gas_therm_to_mwh (float, optional) – Conversion from pence/therm to GBP/MWh (still in higher-heating value). Defaults to 0.029307.
api2_tonne_to_mwh (float, optional) – Conversion from API2 coal to MWh. Defaults to 6.978.
carbon_emissions (float, optional) – The carbon content as tCO2/MWh. This value varies between coal and gas. For coal, the default factor is 0.34056. For gas, the default factor is 0.202.
efficiency (float, optional) – The energy efficiency. For coal, the default factor is 0.42. For gas, the default factor is 0.59.
carbon_tax_area (Area, str, optional) – Set an area to apply tax rules for.
time_zone (TzInfo, optional) – Set the timezone for the date-times
unit (str, optional) – Convert unit of data, defaults to curves unit

Returns

An SRMC object with a period-based series

Return type

load_delivery(curve, begin=None, end=None, period=None, delivery=None, gas_therm_to_mwh=None, api2_tonne_to_mwh=None, carbon_emissions=None, efficiency=None, carbon_tax_area=None, unit=None)¶

Calculate historical short-run margincal costs (SRMC) for a specific contract, such as the year 2021, the month Jan 2021, etc.

SRMC is calculated from a coal or gas curve of your choosing. It uses the daily reference rates from the European Central Bank (ECB) for currency conversions. The EUA price in the calculation is the settlement price from ICE.

Some countries, such as Great Britain, has an additional flat tax on carbon emissions. Specify the carbon_tax_area parameter to apply tax rules for a specific country.

This operation works for coal or gas curves with curve_type = OHLC only.

Parameters

curve (energyquantified.metadata.Curve, str) – The curve or curve name
begin (date, str, required) – The begin date
end (date, str, required) – The end date
period (ContractPeriod, str, required) – Filter on contract period (day, week, month etc.), defaults to None
delivery (date, str, required) – Filter on delivery date, requires parameter period to be set; cannot be used together with front, defaults to None
gas_therm_to_mwh (float, optional) – Conversion from pence/therm to GBP/MWh (still in higher-heating value). Defaults to 0.029307.
api2_tonne_to_mwh (float, optional) – Conversion from API2 coal to MWh. Defaults to 6.978.
carbon_emissions (float, optional) – The carbon content as tCO2/MWh. This value varies between coal and gas. For coal, the default factor is 0.34056. For gas, the default factor is 0.202.
efficiency (float, optional) – The energy efficiency. For coal, the default factor is 0.42. For gas, the default factor is 0.59.
carbon_tax_area (Area, str, optional) – Set an area to apply tax rules for.
unit (str, optional) – Convert unit of data, defaults to curves unit

Returns

An SRMC object with a list of OHLC objects

Return type

load_delivery_as_timeseries(curve, begin=None, end=None, period=None, delivery=None, fill=None, gas_therm_to_mwh=None, api2_tonne_to_mwh=None, carbon_emissions=None, efficiency=None, carbon_tax_area=None, unit=None)¶

Calculate historical short-run margincal costs (SRMC) for a specific contract and convert it to a daily time series.

A specific contract could be the year 2021, the month Jan 2021, etc.

SRMC is calculated from a coal or gas curve of your choosing. It uses the daily reference rates from the European Central Bank (ECB) for currency conversions. The EUA price in the calculation is the settlement price from ICE.

Some countries, such as Great Britain, has an additional flat tax on carbon emissions. Specify the carbon_tax_area parameter to apply tax rules for a specific country.

This operation works for coal or gas curves with curve_type = OHLC only.

Parameters

curve (energyquantified.metadata.Curve, str) – The curve or curve name
begin (date, str, required) – The begin date
end (date, str, required) – The end date
period (ContractPeriod, str, required) – Filter on contract period (day, week, month etc.), defaults to None
delivery (date, str, required) – Filter on delivery date, requires parameter period to be set; cannot be used together with front, defaults to None
fill (str, optional) – How to handle days without trades. Allowed values are: no-fill do nothing, fill-holes fill in holes with data from previous trading day, forward-fill fill in all blanks with data from the previous trading day (also into the future). Defaults to no-fill.
gas_therm_to_mwh (float, optional) – Conversion from pence/therm to GBP/MWh (still in higher-heating value). Defaults to 0.029307.
api2_tonne_to_mwh (float, optional) – Conversion from API2 coal to MWh. Defaults to 6.978.
carbon_emissions (float, optional) – The carbon content as tCO2/MWh. This value varies between coal and gas. For coal, the default factor is 0.34056. For gas, the default factor is 0.202.
efficiency (float, optional) – The energy efficiency. For coal, the default factor is 0.42. For gas, the default factor is 0.59.
carbon_tax_area (Area, str, optional) – Set an area to apply tax rules for.
unit (str, optional) – Convert unit of data, defaults to curves unit

Returns

An SRMC object with a timeseries object

Return type

load_front(curve, begin=None, end=None, period=None, front=None, gas_therm_to_mwh=None, api2_tonne_to_mwh=None, carbon_emissions=None, efficiency=None, carbon_tax_area=None, unit=None)¶

Calculate historical short-run margincal costs (SRMC) for a continuous front contract.

SRMC is calculated from a coal or gas curve of your choosing. It uses the daily reference rates from the European Central Bank (ECB) for currency conversions. The EUA price in the calculation is the settlement price from ICE.

Some countries, such as Great Britain, has an additional flat tax on carbon emissions. Specify the carbon_tax_area parameter to apply tax rules for a specific country.

This operation works for coal or gas curves with curve_type = OHLC only.

Parameters

curve (energyquantified.metadata.Curve, str) – The curve or curve name
begin (date, str, required) – The begin date
end (date, str, required) – The end date
period (ContractPeriod, str, required) – Filter on contract period (day, week, month etc.), defaults to None
front (int, required) – The front contract (1=front, 2=second front, etc.)
gas_therm_to_mwh (float, optional) – Conversion from pence/therm to GBP/MWh (still in higher-heating value). Defaults to 0.029307.
api2_tonne_to_mwh (float, optional) – Conversion from API2 coal to MWh. Defaults to 6.978.
carbon_emissions (float, optional) – The carbon content as tCO2/MWh. This value varies between coal and gas. For coal, the default factor is 0.34056. For gas, the default factor is 0.202.
efficiency (float, optional) – The energy efficiency. For coal, the default factor is 0.42. For gas, the default factor is 0.59.
carbon_tax_area (Area, str, optional) – Set an area to apply tax rules for.
unit (str, optional) – Convert unit of data, defaults to curves unit

Returns

An SRMC object with a list of OHLC objects

Return type

load_front_as_timeseries(curve, begin=None, end=None, frequency=None, period=None, front=None, fill=None, gas_therm_to_mwh=None, api2_tonne_to_mwh=None, carbon_emissions=None, efficiency=None, carbon_tax_area=None, unit=None)¶

Calculate historical short-run margincal costs (SRMC) for a continuous front contract and convert the result to a daily time series.

SRMC is calculated from a coal or gas curve of your choosing. It uses the daily reference rates from the European Central Bank (ECB) for currency conversions. The EUA price in the calculation is the settlement price from ICE.

Some countries, such as Great Britain, has an additional flat tax on carbon emissions. Specify the carbon_tax_area parameter to apply tax rules for a specific country.

This operation works for coal or gas curves with curve_type = OHLC only.

Parameters

curve (energyquantified.metadata.Curve, str) – The curve or curve name
begin (date, str, required) – The begin date
end (date, str, required) – The end date
period (ContractPeriod, str, required) – Filter on contract period (day, week, month etc.), defaults to None
front (int, required) – The front contract (1=front, 2=second front, etc.)
fill (str, optional) – How to handle days without trades. Allowed values are: no-fill do nothing, fill-holes fill in holes with data from previous trading day, forward-fill fill in all blanks with data from the previous trading day (also into the future). Defaults to no-fill.
gas_therm_to_mwh (float, optional) – Conversion from pence/therm to GBP/MWh (still in higher-heating value). Defaults to 0.029307.
api2_tonne_to_mwh (float, optional) – Conversion from API2 coal to MWh. Defaults to 6.978.
carbon_emissions (float, optional) – The carbon content as tCO2/MWh. This value varies between coal and gas. For coal, the default factor is 0.34056. For gas, the default factor is 0.202.
efficiency (float, optional) – The energy efficiency. For coal, the default factor is 0.42. For gas, the default factor is 0.59.
carbon_tax_area (Area, str, optional) – Set an area to apply tax rules for.
unit (str, optional) – Convert unit of data, defaults to curves unit

Returns

An SRMC object with a timeseries object

Return type