Feat: Expand FlexContextSchema with prior commitments by joshuaunity · Pull Request #1754 · FlexMeasures/flexmeasures

joshuaunity · 2025-10-15T15:47:07Z

Description

This PR exposes the commitments by modeling the commitments field into the flex-context schema.

Look & Feel

None

How to test

To test this new addition, follow the steps below

Open up an HTTP client like Postman or Insomnia
Use the api url: http://localhost:5000/api/v3_0/assets/<asset_id>
Use this request body as an example; -+.
you can change the values to what suits you

{
	"flex_context": "{\"commitments\":[{\"baseline\":\"400 kW\",\"up-price\":\"304 EUR/MWh\",\"down-price\":\"530 EUR/MWh\"}]}"
}

Further Improvements

UI to add this new field. This would be handled in 1572

Related Items

This PR closes #1566

Sign-off

I agree to contribute to the project under Apache 2 License.
To the best of my knowledge, the proposed patch is not based on code under GPL or other license that is incompatible with FlexMeasures

Update FlexContext Schema
Implement commitment deserialization in FlexContextSchema

Signed-off-by: joshuaunity <[email protected]>

joshuaunity · 2025-10-15T15:50:11Z

I have implemented the commitments, but I don't know how to accept different units. By this, I mean that the object VariableQuantityField can only take one unit.

Right now, based on the baseline, I validate the prices on that unit. For example, if we have a baseline of MW, the prices should be /MW

From my current understanding, the VariableQuantityField would have to be modified to accept two units. What do you think, @Flix6x

CC @nhoening

read-the-docs-community · 2025-10-15T15:50:33Z

Documentation build overview

📚 flexmeasures | 🛠️ Build #30157995 | 📁 Comparing 0fa0f4c against latest (ec34740)

🔍 Preview build

Show files changed (6 files in total): 📝 6 modified | ➕ 0 added | ➖ 0 deleted

File	Status
changelog.html	📝 modified
genindex.html	📝 modified
_autosummary/flexmeasures.data.models.planning.storage.html	📝 modified
_autosummary/flexmeasures.data.schemas.scheduling.html	📝 modified
_autosummary/flexmeasures.utils.validation_utils.html	📝 modified
api/v3_0.html	📝 modified

Flix6x · 2025-10-16T11:18:04Z

I'd say for now let's be explicit in the type of commitments that we allow: let's start with one type: MW baseline with EUR/MWh prices. We can extend it later, and maybe have separate schemas for each type of commitment, if that helps.

…eScheduler Signed-off-by: F.N. Claessen <[email protected]>

Signed-off-by: F.N. Claessen <[email protected]>

Signed-off-by: joshuaunity <[email protected]>

…easures into feat/flex-commitments

flexmeasures/data/schemas/scheduling/__init__.py

Signed-off-by: joshuaunity <[email protected]>

Flix6x

2 small bugs

flexmeasures/data/models/planning/storage.py

Co-authored-by: Felix Claessen <[email protected]> Signed-off-by: JDev <[email protected]>

Signed-off-by: joshuaunity <[email protected]>

…easures into feat/flex-commitments

Signed-off-by: F.N. Claessen <[email protected]>

… DBFlexContextSchema, so that's the schema we should test against Signed-off-by: F.N. Claessen <[email protected]>

….g. a one-day commitment) Signed-off-by: F.N. Claessen <[email protected]>

Signed-off-by: F.N. Claessen <[email protected]>

…itmentSchema Signed-off-by: F.N. Claessen <[email protected]>

Signed-off-by: F.N. Claessen <[email protected]>

…lidation Signed-off-by: F.N. Claessen <[email protected]>

Signed-off-by: F.N. Claessen <[email protected]>

…s_specs just once Signed-off-by: F.N. Claessen <[email protected]>

Signed-off-by: F.N. Claessen <[email protected]>

…x-commitments # Conflicts: # .github/workflows/lint-and-test.yml

Flix6x

Thanks again for adding those test cases. It helped me figure out what we actually want to support at this point. Right now that is:

A power baseline only (W, kW, MW, J/s, whatever, but not kWh).
Up- and down-prices per power unit or per energy unit (so e.g. EUR/kW and EUR/kWh are both fine).

joshuaunity added 3 commits October 15, 2025 08:51

chore: initialize repo

4e2839b

Signed-off-by: joshuaunity <[email protected]>

chore: cleanup validation function for commitments

9bfda04

Signed-off-by: joshuaunity <[email protected]>

feat: dynamically validating for either power or energy baseline value

35a61f5

Signed-off-by: joshuaunity <[email protected]>

joshuaunity self-assigned this Oct 15, 2025

joshuaunity added enhancement New feature or request Data labels Oct 15, 2025

Merge branch 'main' into feat/flex-commitments

3179e40

Flix6x and others added 5 commits October 16, 2025 14:13

feat: hook up any commitments, defined in flex_context, to the Storag…

2e24d60

…eScheduler Signed-off-by: F.N. Claessen <[email protected]>

dev: suggest todo for deserializing a commitment

c753977

Signed-off-by: F.N. Claessen <[email protected]>

Merge branch 'main' into feat/flex-commitments

2330488

fix: fix flexcontext schema text fail

c99764b

Signed-off-by: joshuaunity <[email protected]>

Merge branch 'feat/flex-commitments' of github.com:FlexMeasures/flexm…

d54097f

…easures into feat/flex-commitments

joshuaunity requested a review from Flix6x October 27, 2025 11:18

Flix6x requested changes Oct 27, 2025

View reviewed changes

flexmeasures/data/schemas/scheduling/__init__.py Outdated Show resolved Hide resolved

joshuaunity added 2 commits October 28, 2025 11:39

chore: implement commiment deserialization util function

e54ff82

Signed-off-by: joshuaunity <[email protected]>

chore: udpates on scheduler debuging

153c475

Signed-off-by: joshuaunity <[email protected]>

Flix6x requested changes Oct 28, 2025

View reviewed changes

flexmeasures/data/models/planning/storage.py Outdated Show resolved Hide resolved

flexmeasures/data/models/planning/storage.py Outdated Show resolved Hide resolved

joshuaunity and others added 10 commits October 28, 2025 13:13

Update flexmeasures/data/models/planning/storage.py

2fa8e3c

Co-authored-by: Felix Claessen <[email protected]> Signed-off-by: JDev <[email protected]>

Update flexmeasures/data/models/planning/storage.py

9b3f1f5

Co-authored-by: Felix Claessen <[email protected]> Signed-off-by: JDev <[email protected]>

chore: add commitment name to Commitment schema under flexcontext schema

21221aa

Signed-off-by: joshuaunity <[email protected]>

Merge branch 'main' into feat/flex-commitments

7981311

chore: modified test case for testing commitments

7c1bd4e

Signed-off-by: joshuaunity <[email protected]>

Merge branch 'feat/flex-commitments' of github.com:FlexMeasures/flexm…

5ad38fb

…easures into feat/flex-commitments

fix: test

42326ba

Signed-off-by: F.N. Claessen <[email protected]>

fix: baseline and prices may be negative

8a66fec

Signed-off-by: F.N. Claessen <[email protected]>

feat: check costs of custom sample commitments

6549bc4

Signed-off-by: F.N. Claessen <[email protected]>

docs: correct docstring

19c9937

Signed-off-by: F.N. Claessen <[email protected]>

Flix6x added 23 commits October 31, 2025 17:25

chore: pin pip

483ac04

Signed-off-by: F.N. Claessen <[email protected]>

fix: commitment support comes from FlexContextSchema rather than from…

4c255ae

… DBFlexContextSchema, so that's the schema we should test against Signed-off-by: F.N. Claessen <[email protected]>

feat: check schema support for commitments using time series specs (e…

3e41fca

….g. a one-day commitment) Signed-off-by: F.N. Claessen <[email protected]>

dev: add todo

a64c138

Signed-off-by: F.N. Claessen <[email protected]>

refactor: move commitment validation from DBFlexContextSchema to Comm…

336289f

…itmentSchema Signed-off-by: F.N. Claessen <[email protected]>

feat: check error message for nested field

78f11fc

Signed-off-by: F.N. Claessen <[email protected]>

fix: assign correct field_name to ValidationError

021abac

Signed-off-by: F.N. Claessen <[email protected]>

fix: actually test mixed price units

b3e9a72

Signed-off-by: F.N. Claessen <[email protected]>

refactor: create util method to check whether schema loads data

4761f56

Signed-off-by: F.N. Claessen <[email protected]>

dev: flag obvious mistake

45194fe

Signed-off-by: F.N. Claessen <[email protected]>

refactor: fix obvious mistake by reusing new util method

3c08086

Signed-off-by: F.N. Claessen <[email protected]>

fix: correct expectation of the field that is not expected to pass va…

70eca90

…lidation Signed-off-by: F.N. Claessen <[email protected]>

feat: check if a regular commitment also works in DBFlexContext

d61667e

Signed-off-by: F.N. Claessen <[email protected]>

fix: DBCommitmentSchema does not allow time series specs

f02199e

Signed-off-by: F.N. Claessen <[email protected]>

refactor: declare NoTimeSeriesSpecs mixin to define forbid_time_serie…

21e8596

…s_specs just once Signed-off-by: F.N. Claessen <[email protected]>

fix: use ._get_unit util method to get unit for a variable quantity

da309cc

Signed-off-by: F.N. Claessen <[email protected]>

feat: test time series specs with wrong baseline unit

61a42ba

Signed-off-by: F.N. Claessen <[email protected]>

feat: test time series specs with wrong up-price unit

7c62b5a

Signed-off-by: F.N. Claessen <[email protected]>

fix: variable quantity validator

eef0076

Signed-off-by: F.N. Claessen <[email protected]>

fix: default to MW in case of missing baseline

5f09bf0

Signed-off-by: F.N. Claessen <[email protected]>

feat: test time series specs in multi-commitment storage test

60beb39

Signed-off-by: F.N. Claessen <[email protected]>

fix: python 3.9 typing

a981bfa

Signed-off-by: F.N. Claessen <[email protected]>

Merge remote-tracking branch 'refs/remotes/origin/main' into feat/fle…

0fa0f4c

…x-commitments # Conflicts: # .github/workflows/lint-and-test.yml

Flix6x added Scheduling API labels Oct 31, 2025

Flix6x approved these changes Nov 1, 2025

View reviewed changes

Flix6x merged commit e7aaa76 into main Nov 1, 2025
8 checks passed

Flix6x deleted the feat/flex-commitments branch November 1, 2025 12:28

Flix6x mentioned this pull request Nov 4, 2025

Fix/default commitment prices #1793

Merged

5 tasks

Flix6x changed the title ~~Feat: Expand FlexContextSchema with previous commitments~~ Feat: Expand FlexContextSchema with prior commitments Nov 19, 2025

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Feat: Expand FlexContextSchema with prior commitments #1754

Feat: Expand FlexContextSchema with prior commitments #1754
Flix6x merged 63 commits intomainfrom
feat/flex-commitments

joshuaunity commented Oct 15, 2025 •

edited by Flix6x

Loading

Uh oh!

joshuaunity commented Oct 15, 2025 •

edited

Loading

Uh oh!

read-the-docs-community bot commented Oct 15, 2025 •

edited

Loading

Uh oh!

Flix6x commented Oct 16, 2025

Uh oh!

Uh oh!

Flix6x left a comment

Uh oh!

Uh oh!

Uh oh!

Flix6x left a comment

Uh oh!

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

2 participants

Conversation

joshuaunity commented Oct 15, 2025 • edited by Flix6x Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Description

Look & Feel

How to test

Further Improvements

Related Items

Sign-off

Uh oh!

joshuaunity commented Oct 15, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

read-the-docs-community bot commented Oct 15, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Documentation build overview

Uh oh!

Flix6x commented Oct 16, 2025

Uh oh!

Uh oh!

Flix6x left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Flix6x left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

2 participants

joshuaunity commented Oct 15, 2025 •

edited by Flix6x

Loading

joshuaunity commented Oct 15, 2025 •

edited

Loading

read-the-docs-community bot commented Oct 15, 2025 •

edited

Loading