Variables browser does not make difference between parameters and variables

[massimo ceraolo]

In variables Browser state variables and parameters have a box that allow selecting a value. In the first case it is an initial value, in the latter it is the value to be held constant during simulation.

When the user runs a complex model (especially if he has not developed it himself) he might not be immediately aware whether a variable is a parameter or a state variable. I would recommend to distinguish the two cases graphically.

Moreover there is no need to plot parameters.

So, to make visual difference between parameters and state variables, the best solution seems to be to make parameter non-selectable for plotting, i.e. without check box or with check-box disabled.
I hope this is possible with a limited effort.

As an alternative, if plotting parameters is deemed a useful feature, we could make a different visual difference, e.g. the box for initial values of state variables could have a greyed background;

[Adeel Asghar]

From my side both solutions are implementable with minimum effort. The only open question is what is more beneficial for the modelers. I added Francesco and Rudiger in the CC list to get an idea what they think about it?

[Francesco Casella]

Replying to ceraolo:

In variables Browser state variables and parameters have a box that allow selecting a value. In the first case it is an initial value, in the latter it is the value to be held constant during simulation.

When the user runs a complex model (especially if he has not developed it himself) he might not be immediately aware whether a variable is a parameter or a state variable. I would recommend to distinguish the two cases graphically.

One option is to put a 'p' or 's' immediately to the left of the value box, and when you hover on it with the mouse you read "Parameter value" or "Initial state value"

Moreover there is no need to plot parameters.

I disagree with that in general. For example, you may have a nominal value of a certain quantity as a parameter and you may want to plot that together with the actual variable, to see how much it strays away over time. I see no reason why this shouldn't be allowed.

[massimo ceraolo]

One option is to put a 'p' or 's' immediately to the left of the value box, and when you hover on it with the mouse you read "Parameter value" or "Initial state value"

If the box is shaded we do not waste any pixel of the precious horizontal space of the Variables Browser, so I would prefer this to adding 'p' or 's'.

I disagree with that in general. For example, you may have a nominal value of a certain quantity as a parameter and you may want to plot that together with the actual variable, to see how much it strays away over time. I see no reason why this shouldn't be allowed.

OK. I himself added this in the bottom part of the ticket's description.

[Adeel Asghar]

Unfortunately Francesco's idea will not work since we can either have an editbox or a text.
The shading proposal is possible. Just to make sure you want greyed background for states or parameters?

Note that greyed background usually mean disabled textbox.

[Francesco Casella]

Replying to adeas31:

The shading proposal is possible. Just to make sure you want greyed background for states or parameters?

Note that greyed background usually mean disabled textbox.

That's what I was thinking, that a greyed background could be misleading. How about an embossed textbox, or a textbox with thicker border?

[Adeel Asghar]

I have attached both alternatives. I don't have any strong opinion.

[Francesco Casella]

I confirm I don't really like the gray background - that really looks too much like a disabled textbox, which is not.

Another option could be to use italics font for either parameter values or initial states. That would show some difference, without catching the eye too much.

@ceraolo, what do you think?

[massimo ceraolo]

Yeah greyed usually means disabled.
After having seen the boxes indeed their visibility is a bit excessive. Adeel can you show us the italics option?
I agree with Francesco that a mimimal differentiation is the best solution.

[massimo ceraolo]

I would suggest also to test the option of using grey font for parameter names (not values), under the idea that they are weaker candidates for plotting than quantities with higher variability.
Having a screen also of this choice would help a shared and nice decision.

[Adeel Asghar]

I suppose when we talk about making it italic or changing the font color then we want it for the whole row.
There are four more alternatives,

1. Italic font.
2. Gray color font.
3. Dark gray color font.
4. Dark gray color italic font.

[massimo ceraolo]

good landscape!
The two I most prefer are DarkGrayItalicParameters and ItalicParameters.
Francesco, in case you feel comfortable with one of these, please propose the winner.

[Francesco Casella]

I'm sorry to waste your time on a subject that is probably a bit of bike shedding, but I don't really get why parameter values (or their description) should be greyed at all. Parameter values are not second class simulation results, compared to variable values, so I don't see any reason to try to make them "less relevant" by making them gray.

BTW, in many cases, simulations go wrong because for some reason (e.g. wrong parameter propagation, or convergence issues with fixed = false parameters) the actual computed values of some parameters are different from what the end user would expect - this happened to me many times. The only way to figure this out is to actually check the computed values in the simulation results. Why should we try to somewhat hide them or make them less visible or seemingly less important? I personally find this outright confusing.

If there is a use case to select only variables (or, possibly, only time-varying variables) for display, we should include a filter in the result window for this purpose. Personally, I don't see a need for that, but it maybe useful in some cases.

Anyway, I understand the goal of this ticket was to differentiate between textboxes to input parameter values, and textboxes to input initial states, which I think is a good idea.

My proposal for this purpose is to make one of the two types of textbox use italics font, so it is clear that there is a difference between parameter values and initial state values. I have no strong opion on which one, though I'd slightly prefer to use italics for initial states. No bold, no grey. Anything more than that seems to me visually too intrusive, without a real reason for being so. In particular, I don't see a reason to change the font of name, unit, and description.

My two cents :)

[massimo ceraolo]

Well, @casella, I myself asked you to make the final decision.
In case you wrote your latest very detailed message to convince me you spoiled your time: I was already convinced.

[Francesco Casella]

Replying to ceraolo:

Well, @casella, I myself asked you to make the final decision.
In case you wrote your latest very detailed message to convince me you spoiled your time: I was already convinced.

Bike shedding is an all-too-powerful temptation :)

[Adeel Asghar]

Parameter textbox use italic font now. a83744b/OMEdit.