Start using automatic documentation for examples #371
Merged
Conversation
This file contains hidden or 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
Collaborator
|
I'm going to merge this into |
Collaborator
Author
|
Sounds good. |
dzalkind
added a commit
that referenced
this pull request
Oct 3, 2024
* Update .readthedocs.yaml * Docs: Fix small bug in docs that caused errors with links * Start using automatic documentation for examples (#371) * Added autodocumentation template for all examples * Add a note about building docs * Fix global variables in Example 17a and 17b * Try numpy<2.0 --------- Co-authored-by: AbhineetGupta <abhineet.gupta@nrel.gov>
dzalkind
added a commit
that referenced
this pull request
Oct 11, 2024
* Update .readthedocs.yaml * Docs: Fix small bug in docs that caused errors with links * Start using automatic documentation for examples (#371) * Added autodocumentation template for all examples * Check for IPC openfast flag when using AWC * Fix GB and gen efficiencies GB efficiency reduces LSS to HSS GEN reduces HSS to generator electrical output We apply the GenTq at the HSS * Allow updating of Ind_BldPitch from int to array * Add a note about building docs * Fix global variables in Example 17a and 17b * Try numpy<2.0 * Fixed bug where TRA_LastRefSpd was set to a generator speed not the LSS speed (#381) * Check for Ind_BldPitch in original_vt --------- Co-authored-by: AbhineetGupta <abhineet.gupta@nrel.gov> Co-authored-by: Ben Clayton <55184924+BenClaytonARUP@users.noreply.github.com>
dzalkind
added a commit
that referenced
this pull request
Oct 25, 2024
* Add initial torque/speed power controllers * Add power control via pitch * Update .readthedocs.yaml * Implement open loop PRC inputs * Add ZMQ PRC inputs, defaults in wfc setpoints * Update to latest scipy functions * Update max_torque_rates * Switch constants to integers * Let R_Speed affect below rated ref speed (based on TSR) * Docs: Fix small bug in docs that caused errors with links * Add open loop control with wind speed breakpoints * Add checks for power control * Start using automatic documentation for examples (#371) * Added autodocumentation template for all examples * Re-enable previous PRC_Mode * Update 5MW yamls for constant power * Edit comments * Check for IPC openfast flag when using AWC * Update discons * Fix GB and gen efficiencies GB efficiency reduces LSS to HSS GEN reduces HSS to generator electrical output We apply the GenTq at the HSS * Allow updating of Ind_BldPitch from int to array * Remove print statement * Add power control example * Fix issue where PRC_Mode 2 was not setting PC_RefSpeed_PRC * Add offset to sine_timeseries * Clean up power control example * Disable WSE automatically outside normal operation * Fix OL_BP_FiltFreq input writing * Check breakpoints of open loop control against maxima * Account for rating command in setpoint smoother * Set up PRC demos and documentation * Elaborate old PRC documentation * Update some example documentation * Update example list in docs * Fix old open loop nomenclature * Fix error message in ol control * Configure PRC example for CI * Add docs images * Add a note about building docs * Fix global variables in Example 17a and 17b * Try numpy<2.0 * Fixed bug where TRA_LastRefSpd was set to a generator speed not the LSS speed (#381) * Document PRC API changes * Check for Ind_BldPitch in original_vt * Update example documentation with figures * Fix another ol_timeseries reference * Fix bug if WE_Mode = 0 * Clean up example 26 * Remove own specified rosco_dll * Add note of WE_Op in ROSCO warning * Fix example 27 name * Put make install builds in same place as pip installed library * Re-initialize WSE/Filter if transitioning from op to nonop and vv * Delete duplicate main in ex 17 * Re-enable ex 20 docs * Update variable descriptions * Filter Nacelle vane signal and use to calculate aligned wind speed --------- Co-authored-by: AbhineetGupta <abhineet.gupta@nrel.gov> Co-authored-by: Ben Clayton <55184924+BenClaytonARUP@users.noreply.github.com>
dzalkind
added a commit
that referenced
this pull request
Jul 30, 2025
* Update .readthedocs.yaml * Docs: Fix small bug in docs that caused errors with links * Start using automatic documentation for examples (#371) * Added autodocumentation template for all examples * Add a note about building docs * Fix global variables in Example 17a and 17b * Try numpy<2.0 * Update example documentation with figures * Add example documentation for 6 - 7 * Remove out of date DISCON table * Update install.rst * Install openfast and io in environment yaml * Update iea openfast models to 4.1 * Update DISCONs, RM1 model for OF4.1 * Update IEA-15 tuning yamls with new Cp path * Update version numbering * Fix beamdyn file parsing * Increment version number * Update Cp file path * Ensure update file write to correct directory * Get correct rosco version into control message * Switch wrap_360 to wrap_180 for nacelle heading * Skip python 3.10 * Shorten IPC example * Use newer schema doc setup * Skip more python 3.10 * Remove extra IEA-15 inputs * Simplify ElastoDynBlade logic * Support for OpenFAST and openfast-io 4.1 (#455) * Install openfast and io in environment yaml * Update iea openfast models to 4.1 * Update DISCONs, RM1 model for OF4.1 * Update IEA-15 tuning yamls with new Cp path * Update version numbering * Fix beamdyn file parsing * Increment version number * Update Cp file path * Ensure update file write to correct directory * Get correct rosco version into control message * Switch wrap_360 to wrap_180 for nacelle heading * Skip python 3.10 * Shorten IPC example * Skip more python 3.10 * Remove extra IEA-15 inputs * Simplify ElastoDynBlade logic * Add docs about adding inputs * Update DISCONs * Remove empty Cp table from example inputs * Update path in ex 19 --------- Co-authored-by: AbhineetGupta <abhineet.gupta@nrel.gov>
dzalkind
added a commit
that referenced
this pull request
Aug 1, 2025
* Update .readthedocs.yaml * Docs: Fix small bug in docs that caused errors with links * Start using automatic documentation for examples (#371) * Added autodocumentation template for all examples * Add a note about building docs * Fix global variables in Example 17a and 17b * Try numpy<2.0 * Update example documentation with figures * Add example documentation for 6 - 7 * Remove out of date DISCON table * Update install.rst * Install openfast and io in environment yaml * Update iea openfast models to 4.1 * Update DISCONs, RM1 model for OF4.1 * Update IEA-15 tuning yamls with new Cp path * Update version numbering * Fix beamdyn file parsing * Increment version number * Update Cp file path * Ensure update file write to correct directory * Get correct rosco version into control message * Switch wrap_360 to wrap_180 for nacelle heading * Skip python 3.10 * Shorten IPC example * Use newer schema doc setup * Skip more python 3.10 * Add FAST.Farm example for zeromq capability demonstration * Remove extra IEA-15 inputs * Simplify ElastoDynBlade logic * Support for OpenFAST and openfast-io 4.1 (#455) * Install openfast and io in environment yaml * Update iea openfast models to 4.1 * Update DISCONs, RM1 model for OF4.1 * Update IEA-15 tuning yamls with new Cp path * Update version numbering * Fix beamdyn file parsing * Increment version number * Update Cp file path * Ensure update file write to correct directory * Get correct rosco version into control message * Switch wrap_360 to wrap_180 for nacelle heading * Skip python 3.10 * Shorten IPC example * Skip more python 3.10 * Remove extra IEA-15 inputs * Simplify ElastoDynBlade logic * Add docs about adding inputs * Update DISCONs * Remove empty Cp table from example inputs * Update path in ex 19 * Convert Example17c from a dummy FAST.Farm to working FAST.Farm example * Fix IEA15 DISCON to point to correct perf file * Rename example 17c to a more descriptive name * Remove IEA Cp table from example inputs * Fix FAST.Farm example inputs to allow for yaw control in ServoDyn; reduce farm size * Add documentation and fix example 17c --------- Co-authored-by: dzalkind <65573423+dzalkind@users.noreply.github.com> Co-authored-by: dzalkind <dzalkind@nrel.gov>
dzalkind
added a commit
that referenced
this pull request
Aug 5, 2025
* Update .readthedocs.yaml * Docs: Fix small bug in docs that caused errors with links * Start using automatic documentation for examples (#371) * Added autodocumentation template for all examples * Add a note about building docs * Fix global variables in Example 17a and 17b * Try numpy<2.0 * Update example documentation with figures * Add example documentation for 6 - 7 * Remove out of date DISCON table * Update install.rst * Install openfast and io in environment yaml * Update iea openfast models to 4.1 * Update DISCONs, RM1 model for OF4.1 * Update IEA-15 tuning yamls with new Cp path * Update version numbering * Fix beamdyn file parsing * Increment version number * Update Cp file path * Ensure update file write to correct directory * Get correct rosco version into control message * Switch wrap_360 to wrap_180 for nacelle heading * Skip python 3.10 * Shorten IPC example * Use newer schema doc setup * Ensure more robust min_pitch behavior, regardless of type input * Dont read HydroDyn in tuning, not used * Throw error for constant nacelle yaw control, not possible * Clean up * Skip more python 3.10 * Add FAST.Farm example for zeromq capability demonstration * Remove extra IEA-15 inputs * Simplify ElastoDynBlade logic * Update DISCONs * Support for OpenFAST and openfast-io 4.1 (#455) * Install openfast and io in environment yaml * Update iea openfast models to 4.1 * Update DISCONs, RM1 model for OF4.1 * Update IEA-15 tuning yamls with new Cp path * Update version numbering * Fix beamdyn file parsing * Increment version number * Update Cp file path * Ensure update file write to correct directory * Get correct rosco version into control message * Switch wrap_360 to wrap_180 for nacelle heading * Skip python 3.10 * Shorten IPC example * Skip more python 3.10 * Remove extra IEA-15 inputs * Simplify ElastoDynBlade logic * Add docs about adding inputs * Update path in ex 19 * Update DISCONs * Remove empty Cp table from example inputs * Update path in ex 19 * Convert Example17c from a dummy FAST.Farm to working FAST.Farm example * Fix IEA15 DISCON to point to correct perf file * Rename example 17c to a more descriptive name * Remove IEA Cp table from example inputs * Fix FAST.Farm example inputs to allow for yaw control in ServoDyn; reduce farm size * Add documentation and fix example 17c * Rotate tower top translational accel * Rename rotational acceleration for clarity * Increase precision of D2R constants, align wrap angles, save more chans * Add yaw control example * Deactivate full test * Add yaw control example to testing * Fix short test for yaw control * Remove unneeded dependencies, sync attributes * Test case library, move run turbsim to function that is tested * Organize test output directory * Update FA_Acc keys in control_interface * Update SS_Acc_TT comment * Remove 08_run_turbsim example from testing, docs --------- Co-authored-by: AbhineetGupta <abhineet.gupta@nrel.gov> Co-authored-by: Abhineet Gupta <gupabhineet@gmail.com>
dzalkind
added a commit
that referenced
this pull request
Aug 19, 2025
* Update .readthedocs.yaml * Docs: Fix small bug in docs that caused errors with links * Start using automatic documentation for examples (#371) * Added autodocumentation template for all examples * Add a note about building docs * Fix global variables in Example 17a and 17b * Try numpy<2.0 * Update example documentation with figures * Add example documentation for 6 - 7 * CL AWC functionality * Remove out of date DISCON table * Closed-loop AWM controller * Updated CL AWM to work for pulse * Updated CL AWC * Update install.rst * WIP helix working, pulse not yet * Cleaned up CL AWC, checked for bugs * Bug fix * Update OpenFAST inputs for v4.1 * Update DISCONs, RM1 model for OF4.1 * Update IEA-15 tuning yamls with new Cp path * Speed up AWC test for CI * Install openfast and io in environment yaml * Update iea openfast models to 4.1 * Update DISCONs, RM1 model for OF4.1 * Update IEA-15 tuning yamls with new Cp path * Update version numbering * Fix beamdyn file parsing * Increment version number * Update Cp file path * Ensure update file write to correct directory * Get correct rosco version into control message * Switch wrap_360 to wrap_180 for nacelle heading * Skip python 3.10 * Shorten IPC example * Use newer schema doc setup * Ensure more robust min_pitch behavior, regardless of type input * Dont read HydroDyn in tuning, not used * Throw error for constant nacelle yaw control, not possible * Clean up * Skip more python 3.10 * Add FAST.Farm example for zeromq capability demonstration * Remove extra IEA-15 inputs * Simplify ElastoDynBlade logic * Update DISCONs * Adding inputs for CL AWC in all helper files * Remove dll static lib, add to gitignore * Fix AWC_phaseoffset writing * Updated discon files * Support for OpenFAST and openfast-io 4.1 (#455) * Install openfast and io in environment yaml * Update iea openfast models to 4.1 * Update DISCONs, RM1 model for OF4.1 * Update IEA-15 tuning yamls with new Cp path * Update version numbering * Fix beamdyn file parsing * Increment version number * Update Cp file path * Ensure update file write to correct directory * Get correct rosco version into control message * Switch wrap_360 to wrap_180 for nacelle heading * Skip python 3.10 * Shorten IPC example * Skip more python 3.10 * Remove extra IEA-15 inputs * Simplify ElastoDynBlade logic * Add docs about adding inputs * Added variables used for CL AWM * Update path in ex 19 * Update DISCONs * Remove empty Cp table from example inputs * Update path in ex 19 * AWC_phaseoffset is always a scalar; regen registry * Regen DISCONs, make sure they have forward slashes * Update IEA-15 monopile example since we now host it * Set up multi-rate shutdown, initial * Update path in ex 19 * Convert Example17c from a dummy FAST.Farm to working FAST.Farm example * Fix IEA15 DISCON to point to correct perf file * Rename example 17c to a more descriptive name * Remove IEA Cp table from example inputs * Add pitch based shutdown * Remove remove_numpy * Bug fixes in response to DZ's comments * Revert "AWC_phaseoffset is always a scalar; regen registry" This reverts commit 452d65f. * Fix FAST.Farm example inputs to allow for yaw control in ServoDyn; reduce farm size * Add documentation and fix example 17c * Rotate tower top translational accel * Rename rotational acceleration for clarity * Increase precision of D2R constants, align wrap angles, save more chans * Add yaw control example * Deactivate full test * Add yaw control example to testing * Fix short test for yaw control * Remove unneeded dependencies, sync attributes * Test case library, move run turbsim to function that is tested * Organize test output directory * Update FA_Acc keys in control_interface * Update SS_Acc_TT comment * Remove 08_run_turbsim example from testing, docs * Sync input/variable name conventions * Update shutdown example * Make shorter test for CI * Remove empty file * Add checks on SD_ inputs * Update units in schema descriptions, discons * Update comments in shutdown example * Use max pitch rate for shutdown after defined stages --------- Co-authored-by: AbhineetGupta <abhineet.gupta@nrel.gov> Co-authored-by: Joeri Frederik <joeri.frederik@nrel.gov> Co-authored-by: Frederik <jfrederi@nrel.gov> Co-authored-by: Abhineet Gupta <gupabhineet@gmail.com>
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
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.
Description and Purpose
This pull request implements the use of automatic documentation for documenting examples.
This is demonstrated with example-1.
Examples need to be modified so that the code is contained within a function.
Otherwise, examples get executed while building the documentation.
Also, the docstrings of other examples need to be modified to be in suitabl rst format like example-1
Type of change
What types of change is it?
TODO Items General:
TODO Items API Change:
Github issues addressed, if one exists
Examples/Testing, if applicable