Skip to content

added version field as optional to track file/design version tags - #191

Open
fzahle wants to merge 1 commit into
mainfrom
version
Open

added version field as optional to track file/design version tags#191
fzahle wants to merge 1 commit into
mainfrom
version

Conversation

@fzahle

@fzahle fzahle commented Jun 25, 2026

Copy link
Copy Markdown
Collaborator

I've made the field optional to avoid making a backward incompatible change.

@fzahle
fzahle requested a review from ptrbortolotti June 25, 2026 12:41

@ptrbortolotti ptrbortolotti left a comment

Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

what about the entry windIO_version?

@fzahle

fzahle commented Aug 6, 2026

Copy link
Copy Markdown
Collaborator Author

what about the entry windIO_version?

Maybe the description is misleading. the intention is to allow tagging the version of the turbine design.

@ptrbortolotti

Copy link
Copy Markdown
Collaborator

that was the intention of windIO_version, or am I missing something?

@fzahle

fzahle commented Aug 6, 2026

Copy link
Copy Markdown
Collaborator Author

that was the intention of windIO_version, or am I missing something?

windIO_version would be 2.1 for example, referring to what version of the windIO schema the file uses, making it easier to convert yaml older yaml files.

@ptrbortolotti

Copy link
Copy Markdown
Collaborator

and what would version do then?

@fzahle

fzahle commented Aug 7, 2026

Copy link
Copy Markdown
Collaborator Author

I can see this field may not be super intuitive to understand. There's also the issue that if a user splits the yaml sub sections into other files, they won't strictly be versioned anyway. Use case is that we for example in the windIO repo maintain copies of the IEA RWTs and that it's error prone and difficult to check what version of the turbine design the file has.

We could also call it turbine_version or model_version or something else to make it more clear that it's the version of the turbine and not windIO the tag is used for.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants