Add some example pictures in the readme and docs

sandialabs · Jul 12, 2024 · 3cab9ae · 3cab9ae
1 parent cb7692c
commit 3cab9ae
Show file tree

Hide file tree

Showing 7 changed files with 108 additions and 16 deletions.
diff --git a/README.md b/README.md
@@ -3,15 +3,62 @@
 [![](https://img.shields.io/badge/docs-stable-blue.svg)](https://sandialabs.github.io/OWENS.jl)
 ![](https://github.com/sandialabs/OWENS.jl/workflows/CI/badge.svg)
 
-This repository is based on the original structural dynamics solver by Brian Owens (see dissertation: http://hdl.handle.net/1969.1/151813).
-The original code has been translated to Julia and revised for simplicity and performance while maintaining accuracy.  GXBeam.jl has also been coupled for geometrically exact beam solutions
-The aerodynamics are provided by the OWENSAero.jl module (https://gitlab.sandia.gov/8821-vawt-tools/OWENSAero.jl) in addition to a coupling to the OpenFAST AeroDyn module. All codes that can be standalone (like the aerodynamics and structures) should be separate and handled through the dependency manager, other functions specific to the OWENS ontology should remain in this repository.
 
-## Examples
-Please see the documentation under examples.
+This package was based on the original structural dynamics solver by Brian Owens (see dissertation: http://hdl.handle.net/1969.1/151813). However, it has been rewritten into the Julia programming language and many of the issues related to aerodynamic coupling and floating dynamics solved, with extensive expansion into other areas and features to provide a seamless and automated process that takes in high level design details and does all of the preprocessing, running, and post processing that is normally done under different roofs or by different manual processes.  This was done with the intent of enabling fast, parametric design.  We have many of the modules propogating automatic gradients, however this is still a future challenge to solve well. 
 
-## Installation 
-Please see the documentation under setup. 
+This package is for experienced researchers with both software and engineering experience who need generalized flexibility and performance that is 100% open source.  If you want a windows compatible GUI, please use QBlade from our friends across the pond.  
 
-## Contributing
-Please make all feature changes and bug fixes as branches and then create pull requests against the dev branch.  The dev branch will be periodically pulled into master for significant version changes.
+Here are several examples of OWENS use cases, current and past, including the Sandia 34m research turbine.
+
+<img src="docs/src/assets/SNL34m.png" alt="drawing" width="400"/>
+
+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.
+
+<img src="docs/src/assets/helical.png" alt="drawing" width="400"/>
+
+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).
+
+<img src="docs/src/assets/biwing.png" alt="drawing" width="400"/>
+
+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).
+
+<img src="docs/src/assets/arcus.png" alt="drawing" width="400"/>
+
+
+# OWENS under the hood
+
+The OWENS.jl package contains functions and interfaces related to the ontology (how everything comes together, forms a wind turbine, and operates like a wind turbine), with preprocessing and postprocessing helper functions. These include automated meshing functions, sectional property mapping, two-way loads mapping, generalized torque and direct mesh controls, algorithms for two-way coupling and time stepping, fatigue and design equivalent load calculation, and all of the ontology and coupling to the other packages used.
+
+OWENSPrecomp.jl is a translation of Precomp and calculates the sectional properties
+
+Composites.jl provides classical laminate theory definitions used for both pre and post processing
+
+OWENSFEA.jl is one of the structural models including a Timoshenko beam solver in the linear and nonlinear steady, modal, time domain, and reduced order modal domains.
+
+GXBeam.jl has also been integrated for geometrically exact beam solutions of the same above
+
+The aerodynamics are provided by the OWENSAero.jl module, or optionally OpenFAST OLAF via OWENSOpenFASTWrappers.jl
+
+Floating dynamics are provided by OWENSOpenFASTWrappers.jl and the HydroDyn and MoorDyn libraries
+
+Turbulent inflow is provided by OWENSOpenFASTWrappers.jl and the inflowwind and turbsim libraries
+
+Rainflow counting was provided by Rainflow.jl, however, this package became orphained and was pulled into the OWENS code base.
+
+## Installation
+Please follow the instructions on the setup page
+
+## Documentation
+- https://sandialabs.github.io/OWENS.jl
+-	All of the functions have docstrings describing the i/o and function purpose, which can be accessed the docs site or by:
+    * import module
+    * ? module.function() 				
+-	A note about julia debuggers – if you don’t want it to step through everything, you need to tell it what packages to compile vs while packages to step through. This will make the debugger comparable (if not faster) than Matlab in speed. In VSCode, this can be done in the debug pane.
+
+## Software License
+
+Copyright 2021 National Technology & Engineering Solutions of Sandia, LLC (NTESS).
+Under the terms of Contract DE-NA0003525 with NTESS, there is a non-exclusive license for use of this work by or on behalf of the U.S. Government.
+Export of this data may require a license from the United States Government.
+
+See Copyright.txt file for more information
diff --git a/docs/src/assets/SNL34m.png b/docs/src/assets/SNL34m.png
diff --git a/docs/src/assets/arcus.png b/docs/src/assets/arcus.png
diff --git a/docs/src/assets/biwing.png b/docs/src/assets/biwing.png
diff --git a/docs/src/assets/helical.png b/docs/src/assets/helical.png
diff --git a/docs/src/getting_started.md b/docs/src/getting_started.md
@@ -0,0 +1,7 @@
+# Optimization Considerations
+
+My text 
+
+[comment] ![](../assets/OWENS_Example_Figure_Building_Blocks.png)
+
+my text
diff --git a/docs/src/index.md b/docs/src/index.md
@@ -1,14 +1,52 @@
-# OWENS (Offshore Wind ENergy Simulator)
+# OWENS (Onshore/Offshore Wind/Water ENergy Simulator)
 
-This repository is based on the original structural dynamics solver by Brian Owens (see dissertation: http://hdl.handle.net/1969.1/151813).
-The original code has been translated to Julia and revised for simplicity and performance while maintaining accuracy.  GXBeam.jl has also been integrated in beta form for geometrically exact beam solutions
-The aerodynamics are provided by the OWENSAero.jl module (https://gitlab.sandia.gov/8821-vawt-tools/OWENSAero.jl) in addition to a coupling to the OpenFAST AeroDyn module.
+This package was based on the original structural dynamics solver by Brian Owens (see dissertation: http://hdl.handle.net/1969.1/151813). However, it has been rewritten into the Julia programming language and many of the issues related to aerodynamic coupling and floating dynamics solved, with extensive expansion into other areas and features to provide a seamless and automated process that takes in high level design details and does all of the preprocessing, running, and post processing that is normally done under different roofs or by different manual processes.  This was done with the intent of enabling fast, parametric design.  We have many of the modules propogating automatic gradients, however this is still a future challenge to solve well. 
 
-## Documentation
+This package is for experienced researchers with both software and engineering experience who need generalized flexibility and performance that is 100% open source.  If you want a windows compatible GUI, please use QBlade from our friends across the pond.  
+
+Here are several examples of OWENS use cases, current and past, including the Sandia 34m research turbine.
+
+<img src="assets/SNL34m.png" alt="drawing" width="400"/>
+
+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.
+
+<img src="assets/helical.png" alt="drawing" width="400"/>
+
+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).
+
+<img src="assets/biwing.png" alt="drawing" width="400"/>
+
+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).
+
+<img src="assets/arcus.png" alt="drawing" width="400"/>
+
+
+# OWENS under the hood
 
-In Work: Documentation can be found in the docs folder along with the validation paper(s).
+The OWENS.jl package contains functions and interfaces related to the ontology (how everything comes together, forms a wind turbine, and operates like a wind turbine), with preprocessing and postprocessing helper functions. These include automated meshing functions, sectional property mapping, two-way loads mapping, generalized torque and direct mesh controls, algorithms for two-way coupling and time stepping, fatigue and design equivalent load calculation, and all of the ontology and coupling to the other packages used.
+
+OWENSPrecomp.jl is a translation of Precomp and calculates the sectional properties
+
+Composites.jl provides classical laminate theory definitions used for both pre and post processing
+
+OWENSFEA.jl is one of the structural models including a Timoshenko beam solver in the linear and nonlinear steady, modal, time domain, and reduced order modal domains.
+
+GXBeam.jl has also been integrated for geometrically exact beam solutions of the same above
+
+The aerodynamics are provided by the OWENSAero.jl module, or optionally OpenFAST OLAF via OWENSOpenFASTWrappers.jl
+
+Floating dynamics are provided by OWENSOpenFASTWrappers.jl and the HydroDyn and MoorDyn libraries
+
+Turbulent inflow is provided by OWENSOpenFASTWrappers.jl and the inflowwind and turbsim libraries
+
+Rainflow counting was provided by Rainflow.jl, however, this package became orphained and was pulled into the OWENS code base.
+
+## Installation
+Please follow the instructions on the setup page
+
+## Documentation
 
--	All of the functions have docstrings describing the i/o and function purpose, which can be accessed by:
+-	All of the functions have docstrings describing the i/o and function purpose, which can be accessed the docs site or by:
     * import module
     * ? module.function() 				
 -	A note about julia debuggers – if you don’t want it to step through everything, you need to tell it what packages to compile vs while packages to step through. This will make the debugger comparable (if not faster) than Matlab in speed. In VSCode, this can be done in the debug pane.