WISDEM install instructions included

README.md

@@ -1,4 +1,6 @@
 # NREL's Reference OpenSource Controller (ROSCO) toolbox for wind turbine applications
+** This is still in early development and is not ready for official release yet. Please do not share without permission from Nikhar Abbas. **
+
 NREL's Reference OpenSource Controller (ROSCO) toolbox for wind turbine applications is a toolbox designed to ease controller implementation for the wind turbine researcher. Some primary capabilities include:
 * Generic auto-tuning of NREL's ROSCO controller
 * Simple 1-DOF turbine simulations for quick controller capability verifications
@@ -9,7 +11,6 @@ Block diagrams of these capabilities can be seen in [architecture.png](architect
 ## Introduction
 The NREL Reference OpenSource Controller (ROSCO) provides an open, modular and fully adaptable baseline wind turbine controller to the scientific community. The ROSCO toolbox leverages this architecture and implementation to provide a generic tuning process for the controller. Because of the open character and modular set-up, scientists are able to collaborate and contribute in making continuous improvements to the code for the controller and the toolbox. The ROSCO toolbox is a mostly-python code base with a number of functionalities.
 
-### ROSCO Toolbox Overview
 * [DRC_Fortran](https://github.com/nikhar-abbas/DRC_Fortran/tree/master) - the python source code for most of the toolbox capabilities.
 * [Examples](https://github.com/NREL/ROSCO_toolbox/tree/master/examples) - short working examples of the capabilities of the ROSCO toolbox. 
 * [Tune_Cases](https://github.com/NREL/ROSCO_toolbox/tree/master/Tune_Cases) - example generic tuning scripts for a number of open-source reference turbines.
@@ -19,22 +20,38 @@ The NREL Reference OpenSource Controller (ROSCO) provides an open, modular and f
 ## Using the ROSCO Toolbox
 There is a short (but _hopefully_ sweet) installation and run process for basic controller tuning...
 
-### Installing the ROSCO Toolbox
-No matter what you desire to do, you will need to install the ROSCO toolbox
-First, clone the git repository and initiate the submodule:
+### Installing the complete ROSCO Toolbox
+No matter what you desire to do, you will need to install the ROSCO toolbox. 
+
+#### WISDEM Dependencies
+The ROSCO toolbox  two NREL tools that are distributed as a part of the WISDEM packages. AerolasticSE and CCBlade are currently used, with future dependencies or support possible. As such, it is necessary to install WISDEM. This can be done fairly easily by following the [WISDEM installation instructions](https://github.com/wisdem/wisdem). A brief overview of the _user_ steps is provided here, for more detail, especially if you would like to contribute to the development of WISDEM, see the [WISDEM github page](https://github.com/wisdem/wisdem).
+
+We recommend creating and activating the same Anaconda environment for both WISDEM and ROSCO:
+
+1. Setup and active this environment form the command prompt (Anaconda3 Power Shell on Windows or Terminal.app on Mac)
+```
+conda config --add channels conda-forge
+conda create -y --name wisdem-env python=3.7
+conda activate wisdem-env
+```
+2. Install WISDEM and it's dependencies
+``` 
+conda install -y wisdem
+```
+#### Installing ROSCO
+You should first be sure that you are stull in the `wisdem-env` environment.
+
+1. clone the git repository and initiate the submodule:
 ``` 
 git clone https://github.com/nikhar-abbas/ROSCO_tooblox.git
 git submodule init
 git submodule update
 ```
-Second, install it from the cloned home directory
+2. Install ROSCO from the cloned home directory
 ```
-pip install -e .
+python setup.py install
 ```
-AeroelasticSE, a part of NREL's WISDEM software, is necessary to have installed as well. This is available at [https://github.com/WISDEM/AeroelasticSE](https://github.com/WISDEM/AeroelasticSE). This can be installed similarly.
-
-### Running ROSCO with Generic Tuning
-The [Tune_Cases](Tune_Cases) folder hosts examples on what needs to happen to write the input file to the ROSCO controller. You will also need to have the ROSCO controller compiled. 
+Note that this may eventually be moved to a full conda install architecture
 
 #### Compiling ROSCO
 The controller itself is installed as a submodule in the ROSCO toolbox. For further information on compiling and running ROSCO itself, especially if you are on a Windows machine, we point you to the [DRC_Fortran github page](https://github.com/nikhar-abbas/DRC_Fortran/tree/develop). For Unix systems, (or Unix shell's on Windows), cmake makes it easy to compile. In order to compile the controller, you should run the following commands from the [DRC_Fortran](DRC_Fortran) folder (note: this folder will be updated with the move of DRC_Fortran to ROSCO).
@@ -46,6 +63,9 @@ make
 ```
 These commands will compile a binary titled `libdiscon.*` in the build folder, which is the binary necessary run the controller. This should only need to be compiled once. 
 
+### Running ROSCO with Generic Tuning
+The [Tune_Cases](Tune_Cases) folder hosts examples on what needs to happen to write the input file to the ROSCO controller. See below on some details for compiling ROSCO:
+
 #### ROSCO Toolbox Generic Tuning
 IF you would like to run the generic tuning process for ROSCO, examples are shown in the [Tune_Cases](Tune_Cases) folder. When you run your own version of [tune_NREL5MW.py](Tune_Cases/tune_NREL5MW.py), you will have two files that are necessary to run the controller. 
 1. `DISCON.IN` - the input file to `libdiscon.*`. When running the controller, `DISCON.IN` must be in the directory that `libdiscon.*` is pointing to, and must be called `DISCON.IN`
@@ -79,6 +99,9 @@ For LaTeX users:
 
 ~~ NJA - add NAWEA/WindTech paper here once published ~~
 
+Additionally, if you have extensively used the [ROSCO](https://github.com/nikhar-abbas/DRC_Fortran/tree/develop) controller or [WISDEM](https://github.com/wisdem/wisdem), please cite them accordingly. 
+
+
 ## Additional Contributors and Acknowledgments
 Primary contributions to this work have been provided by researchers the National Renewable Energy Laboratory and TU Delft. Much of the intellect behind these contributions has been inspired or derived from an extensive amount of work. The bulk of this has been cited through the primary publications about this work.