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
Show file tree
Hide file tree
Changes from 84 commits
Commits
Show all changes
96 commits
Select commit Hold shift + click to select a range
c91a70b
Cast raft_cases, so it's easier to save as an input yaml
dzalkind Dec 6, 2023
15a71c1
fix bug with DT_Out, which is a number, nto a str
ptrbortolotti Dec 14, 2023
24ea956
Flush and close OF input files, seems to fix kestrel issue
dzalkind Dec 19, 2023
ddf70b6
Remove numpy from lists of dicts
dzalkind Dec 19, 2023
c1f1599
Merge remote-tracking branch 'upstream/phase2' into phase2
dzalkind Dec 19, 2023
900a88d
Give a cross sectional HD member property to OF at each joint location
dzalkind Dec 20, 2023
bcc010e
Clean up comment around member cross section properties
dzalkind Dec 20, 2023
88c58c5
Add documentation for constraints that can come from RAFT/OF
dzalkind Dec 20, 2023
a8edbed
Ensure some level is enable for rotor_overspeed merit figure
dzalkind Dec 20, 2023
a2c5424
fix coveralls issue in CI
gbarter Dec 21, 2023
126800b
Make wave_seeds input consistent
dzalkind Dec 22, 2023
d77db57
Merge remote-tracking branch 'upstream/phase2' into phase2
dzalkind Dec 22, 2023
6f43945
Fix zeta_max typo
dzalkind Dec 22, 2023
84cefd2
Add some placeholder doc pages
dzalkind Dec 22, 2023
bdf7cea
Add readthedocs config
dzalkind Dec 22, 2023
2fc8b4d
Output total system inertia from RAFT
dzalkind Jan 4, 2024
8875f41
Add nacelle accel channels
dzalkind Jan 4, 2024
171b010
Remove old ROSCO
dzalkind Jan 5, 2024
a2358eb
Pull ROSCO v2.9.0
dzalkind Jan 5, 2024
ea7f5fc
Squashed 'ROSCO/' content from commit 99c9f872d
dzalkind Jan 5, 2024
e9efbf3
Rename ROSCO_Toolbox imports etc.
dzalkind Jan 5, 2024
e178021
Update example discons
dzalkind Jan 5, 2024
59d65d6
Update to new Tune_Case directory
dzalkind Jan 5, 2024
67a3652
Point to new rosco build directory
dzalkind Jan 5, 2024
2f52774
Pull ROSCO v2.9.0prep
dzalkind Jan 12, 2024
8fab9a3
Squashed 'ROSCO/' changes from 99c9f872d..7fa1ae25e
dzalkind Jan 12, 2024
e931d67
Pull ROSCO v2.9.0prep
dzalkind Jan 12, 2024
5912bf5
Squashed 'ROSCO/' changes from 7fa1ae25e..6c2807a9e
dzalkind Jan 12, 2024
02094ae
Create README.md for example 01
dzalkind Jan 12, 2024
18d67df
Add cmake-build-extension
dzalkind Jan 12, 2024
234f481
Save timeseries and iteration data by default
dzalkind Jan 12, 2024
633541d
Simplify openfast_configuration
dzalkind Jan 12, 2024
c0a7951
Remove perf_surface modeling options because they make bad ROSCOs
dzalkind Jan 12, 2024
8f8536c
Rename optimization example
dzalkind Jan 12, 2024
50c32e2
Update README.md for 02_control_opt
dzalkind Jan 12, 2024
4b576d8
Update modeling schema doc page
dzalkind Jan 12, 2024
81aa2a1
Merge remote-tracking branch 'upstream/docs' into docs
dzalkind Jan 12, 2024
a575482
Rename 02 example folder
dzalkind Jan 12, 2024
481d4bb
Rename output folders in 02 examples
dzalkind Jan 12, 2024
8b6fc0c
Update example names in tests
dzalkind Jan 12, 2024
2ace64d
Remove 03 hydro data, should not be necessary anymore
dzalkind Jan 12, 2024
7ea10a2
Point to wisdem geometry
dzalkind Jan 12, 2024
36c3279
Remove PotFile
dzalkind Jan 12, 2024
bc433b0
Simplify 03 single run analysis options, standardize output file
dzalkind Jan 12, 2024
075a9b6
Standardize 04 example output
dzalkind Jan 12, 2024
284a7fe
Send 04 OF files to regular output
dzalkind Jan 12, 2024
fb8133b
Standardize 05 example inputs
dzalkind Jan 12, 2024
87dbddc
Add readme to example 05
dzalkind Jan 12, 2024
6091a03
Point to 05 wisdem input
dzalkind Jan 12, 2024
9a2c09a
Add README for 06 example
dzalkind Jan 12, 2024
6e013dc
Add README for example 07
dzalkind Jan 12, 2024
87b21eb
Add README for 08 example
dzalkind Jan 12, 2024
9567641
Add README and tidy 06 example inputs some
dzalkind Jan 12, 2024
28de25f
Update test list
dzalkind Jan 12, 2024
e881142
Move comments to 06 README for later use
dzalkind Jan 12, 2024
f8a96a5
Add READMEs
dzalkind Jan 12, 2024
559f783
Tidy up 15_ example inputs
dzalkind Jan 12, 2024
ac61d7b
Rename weis driver in 15_
dzalkind Jan 12, 2024
e3dee9a
Tidy up 13_ example inputs
dzalkind Jan 12, 2024
263a048
Fix path in example 03
dzalkind Jan 12, 2024
74cb443
Ensure that ballast rho is distributed with l_fill
dzalkind Jan 12, 2024
39d37dc
Make BEM dir relative to input files, like most other things
dzalkind Jan 12, 2024
77b6ad7
Make analysis options output relative to input, if it's a relative path
dzalkind Jan 13, 2024
64dca16
Add rank_and_file for example 15
dzalkind Jan 13, 2024
11bea71
Add simple hst file reader
dzalkind Jan 13, 2024
157991a
Pin pyhams 1.2.1
dzalkind Jan 19, 2024
0fd984b
Squashed 'ROSCO/' changes from 6c2807a9e..b994e4de6
dzalkind Jan 19, 2024
366c192
Pull ROSCO v2.9.0
dzalkind Jan 19, 2024
0cea5dd
Merge branch 'rosco290' into docs
dzalkind Jan 19, 2024
65d62db
Merge branch 'main' into docs
dzalkind Jan 26, 2024
d5eb6f0
Clean up discons?
dzalkind Jan 26, 2024
6ee34e5
Replace separate input descriptions with combined WEIS rsts
dzalkind Jan 26, 2024
aa65d53
Point to maintained ROSCO yamls
dzalkind Jan 26, 2024
221925e
Push actual rst file
dzalkind Jan 26, 2024
39d8af5
reg traj file to exmp 02 and init OF + tau1_const
Jan 26, 2024
4889503
Add script to sync with WISDEM inputs
dzalkind Jan 26, 2024
56b1b42
Merge remote-tracking branch 'upstream/docs' into docs
dzalkind Jan 26, 2024
b4aa6a2
improved code to handle initial conditions of openfast
ptrbortolotti Jan 27, 2024
81719cb
Point to monopile properly in 09
dzalkind Jan 30, 2024
d31786b
Merge remote-tracking branch 'upstream/docs' into docs
dzalkind Jan 30, 2024
90f2ca9
Point example 10 to right geometry path
dzalkind Jan 30, 2024
ad62cb0
Fix another geometry path
dzalkind Jan 30, 2024
335dfc1
Update subtree doc to new module development method
dzalkind Feb 7, 2024
05c776f
Revise documentation
dzalkind Feb 8, 2024
759962e
Merge remote-tracking branch 'upstream/develop' into docs
dzalkind Feb 8, 2024
2f4bd90
fix bug in HD reader
ptrbortolotti Feb 27, 2024
ee279ab
get rid of try except for reg traj openfast only
ptrbortolotti Feb 27, 2024
d02f47c
update READMEs and remove bar usc from 08
ptrbortolotti Feb 27, 2024
84cb084
forgot the .py file
ptrbortolotti Feb 27, 2024
bc2cac9
push back bar_usc.yaml
ptrbortolotti Feb 27, 2024
2537ae4
work on AD15 and SD optional inputs
ptrbortolotti Feb 27, 2024
3d82ea6
twr_freq not needed for FB
ptrbortolotti Feb 27, 2024
2bc5f47
write optional OF inputs only if defined
ptrbortolotti Feb 28, 2024
16e4762
Add note about ROSCO dll compilation
dzalkind Feb 28, 2024
ebb74f0
Merge remote-tracking branch 'upstream/docs' into docs
dzalkind Feb 28, 2024
d89ca1a
Update documentation (#271)
AthulKrishnaSundarrajan Mar 5, 2024
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
39 changes: 39 additions & 0 deletions .readthedocs.yaml
Original file line number Diff line number Diff line change
@@ -0,0 +1,39 @@
# .readthedocs.yaml
# Read the Docs configuration file
# See https://docs.readthedocs.io/en/stable/config-file/v2.html for details

# Required
version: 2

# Set the version of Python and other tools you might need
build:
os: ubuntu-22.04
tools:
python: "mambaforge-4.10"
jobs:
# Read the docs needs a couple packages not in the environment file
pre_install:
- conda install cmake compilers


# Shouldn't need conda for building the docs, but it is an option
conda:
environment: environment.yml


# Build documentation in the docs/ directory with Sphinx
sphinx:
configuration: docs/conf.py

# If using Sphinx, optionally build your docs in additional formats such as PDF
# formats:
# - pdf

# Optionally declare the Python requirements required to build your docs
python:
install:
- method: pip
path: .
extra_requirements:
- docs
# system_packages: true
5 changes: 5 additions & 0 deletions docs/dlc_generator.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,5 @@
DLC Generator
-------------


**Inputs to the DLC case generator explained**
54 changes: 15 additions & 39 deletions docs/how_to_contribute_code.rst
Original file line number Diff line number Diff line change
Expand Up @@ -21,54 +21,30 @@ There is currently very little documentation for WEIS, so you have a lot of flex
Do not stress too much about the outline of the information you create, simply that it exists within the repo.
We will reorganize the documentation content at a later date.

Using Git subtrees
------------------
Developing Python Modules Used in WEIS
--------------------------------------
WEIS is comprised of several modules, like WISDEM, ROSCO, and RAFT.
Previously, we used subtrees of each module used in WEIS.
Now, each of these modules are installed via conda.
You can determine which version is installed in your conda environment using::

The WEIS repo contains copies of other codes created by using the :code:`git subtree` commands.
Below are some details about how to add external codes and update them.
conda list | grep wisdem

Adding a subtree for the first time
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
where :code:`wisdem` can be replaced with any of the modules in the :code:`environment.yml`

To add an external code for the first time, using OpenFAST as an example, type:
To make changes in WISDEM, first conda uninstall it::

.. code-block:: bash
conda uninstall --force wisdem # omitting the --force flag will uninstall others, like rosco. Also, mamba is less reliable here.

$ git remote add OpenFAST https://github.com/OpenFAST/openfast
$ git fetch OpenFAST
$ git subtree add -P OpenFAST OpenFAST/dev --squash
Clone the WISDEM repository::

git clone https://github.com/WISDEM/WISDEM.git

The :code:`--squash` is important so WEIS doesn't get filled up with commits from the subtree repos.
and follow the installation instructions of that repository, **while staying within the conda environment used to install weis.**
Since most dependencies will already be installed for each module, you can likely simply navigate to the desired repository and::

Updating a subtree
~~~~~~~~~~~~~~~~~~
pip install -e .

Once a subtree code exists in this repo, we can update it like this.
This first two lines are needed only if you don't have the remote for the particular subtree yet.
If you already have the remote, only the last line is needed.

.. code-block:: bash

$ git remote add OpenFAST https://github.com/OpenFAST/openfast
$ git fetch OpenFAST
$ git subtree pull --prefix OpenFAST https://github.com/OpenFAST/openfast dev --squash --message="Updating to latest OpenFAST develop"

Changes to these subtree codes **should only be made to their original repos**, *not* to this WEIS repo.
Once those individual repos have been updated, use the previous :code:`git subtree pull` command to pull in those updates to the WEIS repo.
Once the upstream repos have your code changes, those changes have been pulled into your branch, you can then submit a PR for WEIS.

Troubleshooting subtree updates
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~

If you run into trouble using :code:`git subtree`, specifically if you see :code:`git: 'subtree' is not a git command.`, try using your system git instead of any conda-installed git.
Specifically, try using :code:`/usr/bin/git subtree` for any subtree commands.
If that doesn't work for you, please open an issue on this repo so we can track it.

Sometimes when updating a subtree, you might get an error that contains :code:`could not rev-parse split hash`, which suggests that the subtree and the more recent branch have diverged in some way.
To fix this, manually remove the entire folder created by the subtree command (e.g. :code:`rm -rf ROSCO`.)
Then, follow the steps to add a repo subtree for the first time.
By deleting then re-adding the subtree repo, you ensure that all the changes are correctly added to the WEIS repo.

Testing
-------
Expand Down
Loading
Loading