search

BHoM / Psychrometrics_Toolkit

GNU Lesser General Public License v3.0
2 stars 1 forks source link

For Excel - could we make it clear what the output units are? #38

Open charliebrookerBH opened 2 years ago

charliebrookerBH commented 2 years ago

Description:

I understand that BHoM works in base SI units, but it would be great it we could make this clear in excel functions, especially where the more common units are kJ, kPa, etc for the specific metric.

e.g add J/kg to the end like so: "Calculates enthalpy from dry-bulb temperature and humidity ratio (J/kg)" image

al-fisher commented 2 years ago

This is a great idea. In Grasshopper you have the output description which includes units (if defined using typeof(Quantities)) reflected on to the output parameter of the component. Naturally not having quite the same format here.

In Excel we could add to the description directly as you have suggested @charliebrookerBH Or perhaps we could also simple append this same Output Description to the main description - stating it is the return value?

Be good to test what will work best in Excel environment - and be most readable and unambiguous

For example for the case of Circle.Area() method

[Description("Calculates the area of the provided geometry.")]
[Input("curve", "The Circle to get the area of.")]
[Input("tolerance", "The tolerance to apply to the area calculation.")]
[Output("area", "The area of the geometry.", typeof(Area))] 
public static double Area(this Circle curve, double tolerance = Tolerance.Distance)

You could have intellisence something like:

Query.Geometry.Area?by_Circle_Double(curve, [tolerance]) Calculates the area of the provided geometry.

Returns: The area of the geometry. [m2] (as a Double)

curve: The Circle to get the area of. A plane curve. Standard circle defining a curve of constant distance from a point, its Centre.

What do you think @IsakNaslundBh, @adecler ?

rboulton-BH commented 1 year ago

Supportive generally of adding units to the description and of adding the output documentation to the display in Excel as it's currently not showing up: image