Add examples and documentation for ParFlorisModel #990
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
paulf81
added
enhancement
misi9170
approved these changes
Oct 7, 2024
misi9170
added a commit
that referenced
this pull request
Oct 7, 2024
* Initial work on a consistent parallel FLORIS model (#977) * Copy for easier comparison and development. * temp commit to save progress. * Starting to build out new ParallelFlorisModel (name not yet fixed). * Begin building tests. * Cleanup and formatting. * Now able to use run() in parallel. * Switch to hidden _get_turbine_powers. * Add backcompatibility with existing parallel model; print timings; add powers_only option. * Example comparing timing. * Formatting fixes. * Test for return_turbine_powers_only flag. * Backcompatibility in configuration. * Appears there is no saving in calling run() twice---all overhead occurs again. * Fix type hints; default for n_wind_condition_splits; remove mistakenly committed yaw optimization function. * Tests for WindData objects; remove related comment. * Tests control setpoints (and add bugfix). Also limit number of workers for testing. * Update UncertainFlorisModel to work with new Parallel framework (#983) * Update uncertain floris model to accept par floris * Raise an error in old parallel floris model blocking passing in uncertain floris model * Add an example of parallelized uncertain floris * Expand parallel processing interface options (#985) * Update example to profile more fully. * Handling for pathos parallel processing package; comparison example to multiprocessing. * Add test for pathos interface. * Add concurrent handling. * minor doc updates. * add pathos requirement * Clean up of new ParFlorisModel class (#986) * Update example to profile more fully. * Handling for pathos parallel processing package; comparison example to multiprocessing. * Add test for pathos interface. * Add concurrent handling. * minor doc updates. * add pathos requirement * Change name to ParFlorisModel throughout. * Add deprecation warning for ParallelFlorisModel. * Add import; isort. * Update example to use ParFlorisModel. * Update tests; formatting. * Fix uncertain-parallel example; add uncertain-parallel test. * Update example docstring. * Remove temporary examples from repository. * Add examples and documentation for ParFlorisModel (#990) * Add short docstring * Minor comment change. * Add approx model to docs * A couple of rewordings and update to initial paragraph. --------- Co-authored-by: paulf81 <[email protected]>
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.
Add examples and documentation for ParFlorisModel
This PR is meant to complete the remaining actions listed in #982 , specifically to add to examples and documentation covering the new
ParFlorisModel. To thatParFlorisModelParFlorisModelandUncertainFlorisModelis added, and a small re-arrangement of the ordering of the documentation is done to have this appear after wind_data_user.