Water Yield naming inconsistency

natcap / invest

InVEST®: models that map and value the goods and services from nature that sustain and fulfill human life.

Apache License 2.0

168 stars 68 forks source link

Water Yield naming inconsistency #401

Closed dcdenu4 closed 2 years ago

dcdenu4 commented 3 years ago

I think this has always been a weird issue, but I've seen

Water Yield (model name in startup)
Hydropower Water Yield (name in model UI and default workspace name)
Annual Water Yield (UG Name and sample data name)
hydropower_water_yeild (CLI name)

I think that we've tried to get away from the Hydropower naming convention and adopt the Annual Water Yield one.

emlys commented 3 years ago

I've seen this with a lot of the models too and I think it's becoming more of a problem now that we have the workbench. It's been confusing figuring out how to refer to a model. The args spec has model_name e.g. 'Wind Energy' and module e.g. natcap.invest.wind_energy, while invest list has two different names: wind_energy and Offshore Wind Energy Production. It would be great to standardize these.

dcdenu4 commented 3 years ago

Yep, and for the Wind Energy model, I reckon it should be offshore_wind_energy, because that's what the model and data are designed for. But, if we decide to mix some of these up that change the UG or user facing UI, we should try and get confirmation with the science leads.

emlys commented 2 years ago

This was fixed in #677.