Detailed explanation of parameter of each model

[cshjin]

As required by https://github.com/dpinney/omf/issues/268, we need a detailed explanation of each input field. A proper explanatory text should include NOTE, TYPE, FORMAT, OPTION, RANGE.

@dpinney Since I am unprofessional in the engineering part, please take a while or ask someone else to work with me.

Also we should proper put it into the wiki.

[Kirktj]

I've started working on this. Here is my interpretation of the fields needed for the explanatory text: Note- explanation of the parameter. Will appear if user hovers mouse over name. Type- integer, string, float, boolean, etc. Format- how the data should be entered. MM/DD/YYYY, XX.XX, etc. Option- I don't know what this means. Check if the input is optional? Range- What is an acceptable answer. 1-100, .1-1, etc.

Are these what you have in mind?

[drdanley]

Add “Suggested default”? One related point -- we need to figure out how to deal with percentages -- do we use "0.76" or "76" or "76%"? I know from experience that this can be a major point or confusion and errors.

[dpinney]

Are these what you have in mind?

Yes, good list. Only one change:

Option- I don't know what this means. Check if the input is optional?

Don't worry about this. I'll have to figure out what's optional based on what SAM/GLD want.

[dpinney]

Add “Suggested default”?

TJ, if you can figure out good defaults go ahead and make a note of them. We have a good collection for most things already.

One related point -- we need to figure out how to deal with percentages -- do we use "0.76" or "76" or "76%"?

Someone propose a solution.

[Kirktj]

I vote for 76 as opposed to .76

[dpinney]

ETA on these tooltips for solarFinancial?

[dpinney]

Inserted as of d9cf03159fa050cd4023e60561907bc514969924. Probably won't need many for solarEngineering, so this issue is done.