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

Restoring Docs PR after Github closed it #261

Merged
merged 96 commits into from
Mar 6, 2024
Merged

Restoring Docs PR after Github closed it #261

merged 96 commits into from
Mar 6, 2024

Conversation

gbarter
Copy link
Member

@gbarter gbarter commented Jan 24, 2024

Purpose

Clean up and revise the example inputs and documentation.

  • Added a few placeholder doc pages (dlc_generator, optimization, weis_outputs)
  • Updated notes on developing python modules in WEIS
  • Combined WISDEM and WEIS inputs into single rst files (still need to add these to readthedocs, and they are not 100% complete)
  • Add examples/00_setup/get_wisdem_yamls.py to pull relevant geometry inputs from WISDEM
  • Pared down input files to only those necessary to run examples. Also reduced unnecessary inputs from individual files. Some examples reference other examples.
  • Made it so that outputs are written relative to the analysis_options.yaml input.
  • Added initial conditions for the openfast-only cases. @ptrbortolotti
  • Fixed bug in l_fill to RAFT, where density was not properly set.

Type of change

What types of change is it?
Select the appropriate type(s) that describe this PR

  • Bugfix (non-breaking change which fixes an issue)
  • New feature (non-breaking change which adds functionality)
  • Breaking change (non-backwards-compatible fix or feature)
  • Code style update (formatting, renaming)
  • Refactoring (no functional changes, no API changes)
  • Documentation update
  • Maintenance update
  • Other (please describe)

Testing

Explain the steps needed to test the new code to verify that it does indeed address the issue and produce the expected behavior.

Checklist

Put an x in the boxes that apply.

  • I have run existing tests which pass locally with my changes
  • I have added new tests or examples that prove my fix is effective or that my feature works
  • I have added necessary documentation

dzalkind and others added 30 commits December 6, 2023 13:05
git-subtree-dir: ROSCO
git-subtree-split: 99c9f872d9590671be6be1a716ac293467b49e53
7fa1ae25e Don't check ZMQ period if no ZMQ_Mode
45aad140c Add more error checking in checkpoint file I/O
c5de22f59 Modernize setup and CI (#297)
REVERT: 99c9f872d Merge remote-tracking branch 'upstream/v2.9.0' into v2.9.0
REVERT: c29fc8597 Fix checkpoint testing paths
REVERT: 75c3d2988 F_NumNotchFilts is not allowed to have a default value
REVERT: ba0bc45d0 Update rosco dylib dir
REVERT: 207d3f73e Add Ext_Interface flag

git-subtree-dir: ROSCO
git-subtree-split: 7fa1ae25e6b3866c353d5976e7ac68f597bf73af
6c2807a9e Merge remote-tracking branch 'upstream/develop' into v2.9.0_prep
4cdef25d4 Merge pull request #300 from NREL/smart_lib_path
b1c943ea0 fixes for windows
8c39105a3 hopefully caught everything
2d0525830 switch to cmake-build-extension and logic for finding rosco library path

git-subtree-dir: ROSCO
git-subtree-split: 6c2807a9ece26b4b94bc0a78bc4ca8388fba60b0
@gbarter
Copy link
Member Author

gbarter commented Feb 2, 2024

@dzalkind - Seems like this is ready to go?

@dzalkind
Copy link
Collaborator

dzalkind commented Feb 5, 2024

Yes, it can be ready to go, but there is always more to document. How about I work on it until Wednesday COB, and then we merge?

@dzalkind
Copy link
Collaborator

dzalkind commented Feb 8, 2024

@ptrbortolotti, I'm not as familiar with examples 05, 07, and 08 as you are. I added placeholder READMEs. Do you want to expand or save for later?

Also, should we pull BAR_USC.yaml from somewhere like the others?

@dzalkind
Copy link
Collaborator

dzalkind commented Feb 8, 2024

@AthulKrishnaSundarrajan, I added a placeholder README in example 14_level2ccd. Do you want to add anything there while we're here? Should anything in 13_DTQP be updated?

@AthulKrishnaSundarrajan
Copy link
Contributor

@AthulKrishnaSundarrajan, I added a placeholder README in example 14_level2ccd. Do you want to add anything there while we're here? Should anything in 13_DTQP be updated?

Readme for 13_DTQP looks good. For 14_level2ccd, I'll work on the readme and a tutorial on how to use LPV models and DTQPy

@ptrbortolotti
Copy link
Collaborator

my apologies for the delays @dzalkind ! I should have now addressed your (good) comments

@dzalkind
Copy link
Collaborator

dzalkind commented Mar 6, 2024

Only the Windows CI tests are failing, which we can address in a future PR.

@dzalkind dzalkind merged commit 5076e9d into develop Mar 6, 2024
15 of 21 checks passed
@dzalkind dzalkind deleted the docs branch March 14, 2024 22:42
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

4 participants