From 143707af1da72379adeddd90cc485e15a153dc5a Mon Sep 17 00:00:00 2001 From: kevmoor Date: Mon, 9 Sep 2024 20:28:30 -0600 Subject: [PATCH] Minor docs updates --- docs/src/index.md | 12 ++++++++---- docs/src/setup.md | 11 +++++------ 2 files changed, 13 insertions(+), 10 deletions(-) diff --git a/docs/src/index.md b/docs/src/index.md index e9bb81d2..a88b3bda 100644 --- a/docs/src/index.md +++ b/docs/src/index.md @@ -6,19 +6,23 @@ This package is for experienced researchers with both software and engineering e Here are several examples of OWENS use cases, current and past, including the Sandia 34m research turbine. -drawing +![SNL34m.](./assets/SNL34m.png){#fig:34m +width="50%"} Then here is an example of a helical design. Note that arbitrary numbers of struts can be specified in the automatic meshing functions. You can also write your own generalized mesh using the internal building blocks, but it is not thouroughly documented. -drawing +![helical.](./assets/helical.png){#fig:34m +width="50%"} The generalized meshing was modified to include HAWT concepts, like this bi-wing concept. OWENS is capable of axial flow turbines/HAWTs, but it is not a mature feature, and no where near as developed as OpenFAST (i.e. for regular HAWTs it is recommended to use that software). -drawing +![biwing.](./assets/biwing.png){#fig:34m +width="50%"} Then, floating turbines are a possibility, though this feature adds another dimension to the nonlinear time stepping convergance and in turn a fair amount of time. Future work is to make this general interface and functionality an easy to use feature (right now it needs a high level of experience to use). -drawing +![arcus.](./assets/arcus.png){#fig:34m +width="50%"} # OWENS under the hood diff --git a/docs/src/setup.md b/docs/src/setup.md index 4c286a55..3d19323f 100644 --- a/docs/src/setup.md +++ b/docs/src/setup.md @@ -20,9 +20,6 @@ Install julia, paraview, and visual studio manually by downloading the windows e - https://www.paraview.org/download/ - https://visualstudio.microsoft.com/downloads/ -Also download OpenFAST: -- https://github.com/OpenFAST/openfast - Be sure julia is on your path, and follow the windows compilation instructions for the openfast Inflowwind, AeroDyn, MoorDyn and HydroDyn libraries. Installation is otherwise the same as the Linux instructions below ## Mac @@ -41,7 +38,7 @@ Essentially the same installation as Linux except we recommend using the homebre ## Linux -# Install/Update Required Compilers and Programs, if you already have an environment that can build OpenFAST, then these should already be installed. +Install/Update Required Compilers and Programs; If you already have an environment that can build OpenFAST, then these should already be installed. apt-get update -y apt-get install git -y @@ -64,8 +61,8 @@ Additionally, if you are not finding that your path is being appended to, you ca alias julia="path/to/your/julia-1.x.x/bin/julia" -# Proxy Setup -If you are using a proxy, be sure that the proxy variables are declared/exported in your .bash_profile or .bashrc or the equivalent +# Environment Variables +If you are using a proxy, be sure that the proxy variables are also declared/exported in your .bash_profile or .bashrc or the equivalent http_proxy, https_proxy, HTTP_PROXY, HTTPS_PROXY, no_proxy, NO_PROXY git config --global http.proxy http://user:nopass@proxy.yourorg:number @@ -105,6 +102,8 @@ Additionally, if you find that your ssh is erroring when you try to install pack PubkeyAcceptedAlgorithms +ssh-ed25519 # Install Optional OpenFAST Dependices +Note that this is optional as it is automatically done by julia in the OWENSOpenFASTWrappers.jl deps/build.jl. For Windows, please follow the OpenFAST Windows instructions on the openfast site for the branch referenced here. + mkdir coderepos cd coderepos # Install openfast coupled libraries !NOTE!: if you change the location of the compiled libraries, you may need to update the rpath variable, or recompile.