-
Notifications
You must be signed in to change notification settings - Fork 156
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
Bug fix: Convert layout
to layout_x
and layout_y
in FlorisInterface.reinitalize
#470
Conversation
layout
to layout_x
and layout_y
in FlorisInterface.reinitalize
I agree with this change, thank you @RHammond2 My only thought, to not brake legacy code, what do you and @rafmudaf and @bayc think about allowing still the layout to be passed in (and a small block that parses it back to layout_x and layout_y in that case)? We can add a deprecation warning that we'll phase it out completely in 3.3 or something? |
With |
@rafmudaf, I think that implementing deprecation warning and encouraging the use of layout_x and layout_y in place of layout, in addition to changing all the examples so they rely on the use of layout_x and layout_y, should help transition users into not using the layout parameter. I'm happy to defer to you if you think we should implement the change immediately, but realizing that this would break users' code, giving a minor release in between breakage seemed kinder. |
You're right @rafmudaf in theory that issue will not be resolved until we cease allowing layout, but I agree having a minor release with a deprecation warning seems kinder |
That sounds good to me, as well. In that case, @RHammond2 I've removed the "closes" word in your original post so that GitHub doesn't automatically close that issue. |
That works for me to not close this. Should we tag this with a new v3.3 tag to remind ourselves of it? |
Yes very good idea! |
Agree, starting to flag some things for v3.3 sounds great! |
Feature or improvement description
This PR modifies
FlorisInterface.reinitialize()
to transition thelayout
parameter to belayout_x
andlayout_y
and all reliant functionality. This resembles the behavior within FLORIS itself, and clears up the confusion surrounding what the correct dimensions oflayout
should be and accidental truncating of a farm's layout.Related issue, if one exists
#413
Impacted areas of the software
floris.tools.floris_interface.FlorisInterface
floris.tools.optimization.pyoptparse.layout.Layout
floris.tools.uncertainty_interface.UncertaintyInterface
Additional supporting information
n/a
Test results, if applicable
All tests pass, though there aren't any tests for this class as it stands.