Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

[BUGFIX] Add enable_active_wake_mixing field to v3 to v4 documentation and conversion #878

Merged
merged 8 commits into from
Apr 12, 2024

Conversation

misi9170
Copy link
Collaborator

@misi9170 misi9170 commented Apr 10, 2024

As part of the merge of #842 , a new field enable_active_wake_mixing was added to the wake field of the main floris input yaml.

The documentation describing the switch from v3 to v4 missed this detail; additionally, the converter utility convert_floris_input_v3_to_v4.py does not currently add this necessary field, so converted floris input files would currently not actually run.

In this PR, I've fixed the documentation added the enable_active_wake_mixing field to the converter, and tested it by converting a v3 GCH floris input file to v4 and running the first example with it.

I've also fixed the Helix operation model documentation to correctly print the figure and produce turbine powers. I've run a local docs build and the resulting html looks good (see screenshot below), so hopefully that means the deploy-pages build will work.

Note that the power calculation produces warnings because the GCH model (not the EmG model) is being used for the calculation. I think that's fine (maybe even good, for exposition)---this documentation is only supposed to be an exposition of the operation model, which is working as intended. @jfrederik-nrel has updated the power calculation demo to use the EmG model, which avoids raising warnings.

helix-docs-2

Also included:

  • Some broken links to the documentation in the README
  • A bugfix @paulf81 pushed to develop to fix the documentation earlier.

@misi9170 misi9170 added the bug Something isn't working label Apr 10, 2024
@rafmudaf
Copy link
Collaborator

@misi9170 since develop and main are at the same commit now, you might consider merging this one to main. That way, you can also fix the broken links in the README here.

@misi9170
Copy link
Collaborator Author

@misi9170 since develop and main are at the same commit now, you might consider merging this one to main. That way, you can also fix the broken links in the README here.

That's a good idea. I'll add those fixes later today. Will we need a new release tag, or is it fine to merge directly to main (and then back to develop) without a release tag in that case?

@rafmudaf
Copy link
Collaborator

I'd bet that there will be more things to fix in the next couple of weeks, so I would wait to aggregate them into v4.0.1.

@misi9170 misi9170 changed the base branch from develop to main April 10, 2024 19:24
Copy link
Collaborator

@jfrederik-nrel jfrederik-nrel left a comment

Choose a reason for hiding this comment

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

Looks good, Misha!

Copy link
Collaborator

@paulf81 paulf81 left a comment

Choose a reason for hiding this comment

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

This looks good, thank you @misi9170

@misi9170 misi9170 changed the base branch from main to develop April 12, 2024 14:44
@misi9170 misi9170 merged commit f704aab into NREL:develop Apr 12, 2024
8 checks passed
@misi9170 misi9170 deleted the bugfix/enable-awc branch April 12, 2024 14:45
@misi9170 misi9170 mentioned this pull request Apr 24, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
bug Something isn't working documentation
Projects
None yet
Development

Successfully merging this pull request may close these issues.

4 participants