diff --git a/README.md b/README.md index bf746e0a..210d8848 100644 --- a/README.md +++ b/README.md @@ -5,20 +5,20 @@ NREL's Reference OpenSource Controller (ROSCO) for wind turbine applications use The NREL Reference OpenSource Controller (ROSCO) provides an open, modular and fully adaptable baseline wind turbine controller to the scientific community. New control implementations can be added to the existing baseline controller, and in this way, convenient assessments of the proposed algorithms is possible. Because of the open character and modular set-up, scientists are able to collaborate and contribute in making continuous improvements to the code. ROSCO is being developed in Fortran and uses the Bladed-style DISCON controller interface. The compiled controller is configured by a single control settings parameter file, and can work with any wind turbine model and simulation software using the DISCON interface. Baseline parameter files are supplied for the NREL 5-MW and DTU 10-MW reference wind turbines. ## Compiling ROSCO -Compiling ROSCO to be used on your machine is made simple using [cmake](https://cmake.org/). +Compiling ROSCO to be used on your machine is made simple using [cmake](https://cmake.org/) on Unix based machines. Currently (November 2019), we recommend that you compile the code using a unix machine (or subsystem on Windows). Compiled binaries are also provided via github. ### Required Software to build ROSCO * Fortran compiler (GNU compiler version above 4.6.0 or Intel compiler version above 11) * C/C++ compiler * GNU Make (version 3.81 or later) -* CMake (version 2.8.12 or later) +* CMake (version 2.8.12 or later) - for unix ### Steps to compile First, clone the git repository: ``` git clone https://github.com/nikhar-abbas/DRC_Fortran.git ``` -Second, create a build directory and run cmake. From the ROSCO home directory: +Second, you will need to compile the controller. From the ROSCO home directory: ``` mkdir build cd build