Skip to content

Commit

Permalink
Decrease overlap of API functions
Browse files Browse the repository at this point in the history
  • Loading branch information
kevmoor committed Sep 10, 2024
1 parent 42c9c62 commit 6c60ca1
Show file tree
Hide file tree
Showing 8 changed files with 22 additions and 50 deletions.
12 changes: 7 additions & 5 deletions docs/make.jl
Original file line number Diff line number Diff line change
Expand Up @@ -15,11 +15,13 @@ makedocs(;
joinpath("examples", "C_customizablePreprocessing.md"),
],
"Developer Guide" => "OWENS_Dev_Guide.md",
"OWENS Functions Reference" => joinpath("reference", "reference.md"),
"OWENSAero Functions Reference" => joinpath("reference", "referenceAero.md"),
"OWENSFEA Functions Reference" => joinpath("reference", "referenceFEA.md"),
"OWENSOpenFASTWrappers Functions Reference" => joinpath("reference", "referenceOpenFASTWrappers.md"),
"OWENSPreComp Functions Reference" => joinpath("reference", "referencePreComp.md"),
"API Reference" => [
joinpath("reference", "reference.md"),
joinpath("reference", "referenceAero.md"),
joinpath("reference", "referenceFEA.md"),
joinpath("reference", "referenceOpenFASTWrappers.md"),
joinpath("reference", "referencePreComp.md"),
],
"Legacy User Guide" => "legacyUserGuide.md",
"Legacy VAWTGen Guide" => "VAWTGenUserGuide.md",
],
Expand Down
14 changes: 5 additions & 9 deletions docs/src/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -9,23 +9,19 @@ OWENS is an ontology, or way of coupling modular aerodynamic, structural, hydrod

Here are several examples of OWENS use cases, current and past, including the Sandia 34m research turbine.

![SNL34m.](./assets/SNL34m.png){#fig:34m
width="50%"}
![SNL34m.](./assets/SNL34m.png){}

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.

![helical.](./assets/helical.png){#fig:34m
width="50%"}
![helical.](./assets/helical.png){}

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).

![biwing.](./assets/biwing.png){#fig:34m
width="50%"}
![biwing.](./assets/biwing.png){}

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).

![arcus.](./assets/arcus.png){#fig:34m
width="50%"}
![arcus.](./assets/arcus.png){}


# OWENS under the hood
Expand All @@ -48,7 +44,7 @@ Turbulent inflow is provided by OWENSOpenFASTWrappers.jl and the inflowwind and

Rainflow counting was provided by Rainflow.jl, however, this package became orphained and was pulled into the OWENS code base.

<img src="./assets/OWENS_Processes.png" alt="drawing" width="400"/>
![arcus.](./assets/OWENS_Processes.png){}

## Installation
Please follow the instructions on the setup page
Expand Down
11 changes: 0 additions & 11 deletions docs/src/installation.md
Original file line number Diff line number Diff line change
Expand Up @@ -21,9 +21,7 @@ Install julia, paraview, and visual studio manually by downloading/installing th
- https://www.paraview.org/download/
- https://visualstudio.microsoft.com/downloads/

<<<<<<< HEAD:docs/src/setup.md
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
=======

When setting up ssh keys, be sure to follow the windows specific instructions https://docs.github.com/en/authentication/connecting-to-github-with-ssh/generating-a-new-ssh-key-and-adding-it-to-the-ssh-agent and note that you may have to use id_ecdsa keys.

Expand All @@ -36,7 +34,6 @@ If you wish to use the openfast libraries, follow the windows compilation instru
Set up VS code as also described below.

Windows notes: details are key, hash mismatch may mean that you are behind a proxy and the proxy isn't setup correctly. For visual studio, the default installation and recommendations should work. If importing the provided vs-code profile, the quick keys may need to be remapped to control from cmd.
>>>>>>> 8e25223abc25ab4cbff6714daea56eaa9fd1a700:docs/src/installation.md

## Mac

Expand Down Expand Up @@ -78,11 +75,7 @@ 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"

# Environment Variables
<<<<<<< HEAD:docs/src/setup.md
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
=======
If you are using a proxy, be sure that the proxy variables are declared/exported in your .bash_profile or .bashrc or the equivalent
>>>>>>> 8e25223abc25ab4cbff6714daea56eaa9fd1a700:docs/src/installation.md

http_proxy, https_proxy, HTTP_PROXY, HTTPS_PROXY, no_proxy, NO_PROXY
git config --global http.proxy http://user:[email protected]:number
Expand Down Expand Up @@ -122,12 +115,8 @@ Additionally, if you find that your ssh is erroring when you try to install pack
PubkeyAcceptedAlgorithms +ssh-ed25519

# Install Optional OpenFAST Dependices
<<<<<<< HEAD:docs/src/setup.md
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.

=======
If your system is already set up such that it is capable of compiling OpenFAST, and you are on mac or linux, then you may skip this and rely on the automatically compiled version that are created when the OWENSOpenFAST libraries are installed by Julia.
>>>>>>> 8e25223abc25ab4cbff6714daea56eaa9fd1a700:docs/src/installation.md
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.
Expand Down
3 changes: 2 additions & 1 deletion docs/src/reference/reference.md
Original file line number Diff line number Diff line change
@@ -1,3 +1,4 @@
# OWENS
```@meta
CurrentModule = OWENS
```
Expand All @@ -11,4 +12,4 @@ CurrentModule = OWENS

```@autodocs
Modules = [OWENS]
```
```
8 changes: 2 additions & 6 deletions docs/src/reference/referenceAero.md
Original file line number Diff line number Diff line change
@@ -1,14 +1,10 @@
# OWENSAero
```@meta
CurrentModule = OWENS
```

## Index

```@index
```

## Types and functions

```@autodocs
Modules = [OWENS.OWENSAero]
```
```
8 changes: 2 additions & 6 deletions docs/src/reference/referenceFEA.md
Original file line number Diff line number Diff line change
@@ -1,14 +1,10 @@
# OWENSFEA
```@meta
CurrentModule = OWENS
```

## Index

```@index
```

## Types and functions

```@autodocs
Modules = [OWENS.OWENSFEA]
```
```
8 changes: 2 additions & 6 deletions docs/src/reference/referenceOpenFASTWrappers.md
Original file line number Diff line number Diff line change
@@ -1,14 +1,10 @@
# OWENSOpenFASTWrappers
```@meta
CurrentModule = OWENS
```

## Index

```@index
```

## Types and functions

```@autodocs
Modules = [OWENS.OWENSOpenFASTWrappers]
```
```
8 changes: 2 additions & 6 deletions docs/src/reference/referencePreComp.md
Original file line number Diff line number Diff line change
@@ -1,14 +1,10 @@
# OWENSPreComp
```@meta
CurrentModule = OWENS
```

## Index

```@index
```

## Types and functions

```@autodocs
Modules = [OWENS.OWENSPreComp]
```
```

0 comments on commit 6c60ca1

Please sign in to comment.