FLORIS v3.3 #586
Merged
FLORIS v3.3 #586
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
* replace wrap functions with faster implementations * slight change to unit test as 180 -> -180 * Update doc string to reflect accurate return type
List examples in numeric order Small cleanup to Examples listing
Remove TOC from intro page
Include undocumented objects as well as all members of an object Add all default autodoc options to config
And other minor changes
Move docs to Jupyter Book and expand content
This means users don’t have to also import matplotlib.pyplot as plt only to run plt.show()
* initial entry for cumulative curl * copy in v2 references * add cc references * add cc refs * replace references to zrefs with references.bib
Also replaces another method CutPlane.subtract to do something similar. That one made assumptions about the order and expected operations. The new subtract method expects all preprocessing to be down outside of the class.
In subsequent function calls, the yaw angles are not reset when they are all zeros. This means that if initially the yaw angles are non-zero and then they’re all-zero, the non-zero yaw settings are retained.
* remove potentially error causing line * Update codecov upload action to v3 Co-authored-by: Rafael M Mudafort <rafael.mudafort@nrel.gov>
And clean up examples imports
minSpeed, maxSpeed => min_speed, max_speed
Here, it’s only adding a blank line at the end
Import formatting. Ruff is not yet at parity with isort, but it is pretty close.
Use pre-commit with Actions Also update the developer dependencies
Add Ruff linting and autoformatting
* Enable and fix pre-commit formatting hooks * Add pre-commit instructions to developer documentation
…einitialize (#453) * Provide ability to pass het_map to reinitialize * re-order reinitialize inputs * Add a new example * Add an error if het map doesnt match on dimensions to wd * Add error example to example * updating format of example * Add indication final error is on purpose * line length check * Comment out forced error * Add example 16b to docs * use n directions instead of x * Add comment --------- Co-authored-by: Paul <paul.fleming@nrel.gov> Co-authored-by: bayc <christopher.j.bay@gmail.com>
* Preserve isort formatting - run it last Also enables splitting imports on trailing comma. If a multi-line import statement is short and includes a trailing comma, it will not be refactored into a single line. * Use token for codecov upload * Reduce computational load in an example Initially, this example slowed the Actions workflow by 2x. This commit reduces the amount of work in the example to speed up the Actions workflow. * Restrict PyPI deploy workflow to NREL/floris * Run tests regardless of linting results * Fail the linter * Revert "Fail the linter" This reverts commit d7bfa62.
* Add func calculate_horizontal_plane_with_turbines * Add demo example * Correct sort order * Improve resolution and force matching range * fix append * Remove calculate with turbine from floris interfa * Delete turbine scan example * Add calc with turbines to visualizations.py * Add vis with turbine to visualization example * Support for yaw angles * Fix handling of yaw angles * fix outdated layout keyword * ruff linting * test pre-commit * test pre-commit * Pre-commit fixes * Fixed doc errors * Clean out commented code * Preserve isort formatting - run it last Also enables splitting imports on trailing comma. If a multi-line import statement is short and includes a trailing comma, it will not be refactored into a single line. * Use token for codecov upload * Reduce computational load in an example Initially, this example slowed the Actions workflow by 2x. This commit reduces the amount of work in the example to speed up the Actions workflow. * Restrict PyPI deploy workflow to NREL/floris * Add info on plotting method * Use coarse mesh for turbine plotting --------- Co-authored-by: Rafael M Mudafort <rafmudaf@gmail.com>
* Add LinearNDInterpolant to wind_rose * Change from returning interpolant to immediately interpolating to values * Add example to docstring --------- Co-authored-by: Paul <paul.fleming@nrel.gov> Co-authored-by: Rafael M Mudafort <rafmudaf@gmail.com>
* minor formatting updates * start overhaul of docuemntation structure * convert input reference to markdown for consistency * add a serious placeholder for theory and update the example input file * remove my notes * add top-level workflow description for getting started * add missing period * Add intro notebook * Add developer section to menu * Bug fix: fix toc reference to placeholder page * Warning fix: use alternate cross reference form --------- Co-authored-by: Rafael M Mudafort <rafmudaf@gmail.com>
* add the external library functionality * update tests for new functionality * enable future typing * fix extra white space * remove extra parameters * add missing test file * fix name bug and address #513 * get tests passing and ensure dictionary entries still work * address Raf's comment * add _path to turbine library references * update typo, FI, and tests for _path * fix error on case of using turbine dictionary and missing air density * add additional test for the unique turbine check
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Feature or improvement description
This pull request is meant to start the process for merging
developintomainand create a v3.3 release. This release is primarily internal code and documentation improvements, and it does not include very many user-facing improvements. The primary change for users is that the documentation will have a better structure and some improved content. For developers, the primary change is that styling is now made more consistent through the integration of ruff as a linter.There are a few remaining things to do:
Remove sections of the user API that were marked as deprecated in v3.1 (see Planned API changes and deprecations #488)Release Checklist