Spine-Toolbox icon indicating copy to clipboard operation
Spine-Toolbox copied to clipboard

Allowable Parameter Types

Open DillonJ opened this issue 1 year ago • 3 comments

This functionality was planned at some stage and I just wanted to check if it's in the plan.

A major issue in SpineOpt is that some parameters need to be a specific type. However, we have no current way to enforce this in toolbox. Duration parameters like minimum_up_time are an example. Time and again, users get caught out by either entering a scalar value for these parameters or typing in a duration value like "1h" that gets stored as a string rather than a duration. The user will then get an error in SpineOpt and the cause is not easily identified for a new user.

Toolbox supports timeseries, time pattern, scalar and map parameters but in the parameter definiition we need to be able to enforce a specific subset of these for individual parameters.

I have a couple of questions:

  1. Does the new data structure allow for this?
  2. Is it in the implementation plan?

@jkiviluo @manuelma ?

DillonJ avatar Jun 22 '23 09:06 DillonJ

The new data structure will allow this, but this part has not yet been implemented. So, it's in the plan, which is not written out clearly anywhere as far as I remember - we should do that. Meanwhile, there is this diagram: https://drive.google.com/file/d/1Ujd17uTIdn_chPdYNhLa6xWQCC_wPKtQ/view?usp=sharing

jkiviluo avatar Jun 22 '23 09:06 jkiviluo

Thanks @jkiviluo that's what I thought... I was just surprised there wasn't already an issue on this, but we have it now

DillonJ avatar Jun 22 '23 13:06 DillonJ

This would have prevented this issue: https://github.com/spine-tools/SpineOpt.jl/issues/937 and a lot of issues like it.

I think it would be a very valuable functionality that we've needed for a long time. I see it's tagged wit the V0.8 milestone. It would be nice if it could get done somehow

DillonJ avatar Mar 13 '24 14:03 DillonJ