search

calliope-project / calliope

A multi-scale energy systems modelling framework
https://www.callio.pe
Apache License 2.0
276 stars 89 forks source link

Change the name of 'tech_groups' to 'tech_class' #600

Open tud-mchen6 opened 1 month ago

tud-mchen6 commented 1 month ago

What can be improved?

tech_groups, as well as node_groups, can be confusing names. According to the documentation, they are actually 'parent' techs or nodes that can be inherited by other techs rather than a group of different techs or nodes. We do not specifically propose for the name tech_class, but something similar and more explanatory to what it actually is.

Version

v0.7

irm-codebase commented 2 weeks ago

I agree on this, particularly when combined with #604. tech_class makes sense to me, but maybe there is a better name...

brynpickering commented 2 weeks ago

We want to try and avoid overlapping with Python terminology as much as possible, hence why class isn't ideal (and why we have base_tech and not tech_class in the main tech config). group is also a relatively close synonym of class so if one causes confusion then so might the other. We likely need is something more closely aligned to parent, but I don't have a good idea on what that could be.

irm-codebase commented 2 weeks ago

I actually like class because it makes sense in terms of inheritance / behavior... group is problematic because it can be confused with subsets of a dimension.

parent is fine too (mostly because "parent class" is a common term in SW). If we want to avoid class I think it is good too!