search

NREL / ROSCO_toolbox

A repository for generating ROSCO controller input files and more.
http://rosco-toolbox.readthedocs.io/
Apache License 2.0
24 stars 20 forks source link

Draft: Clarifying docs for Windows users (mingw) #44

Closed jennirinker closed 3 years ago

jennirinker commented 3 years ago

Looking for review on these docs changes -- I can't build the docs locally so I had trouble checking the formatting/references. If the text looks okay, feel free to correct small things, clear the "Draft" status and merge in.

We've figured out how to compile ROSCO on Windows (hopefully), and thought we might clarify the docs to help other end users. We never figured out how to build a 32-bit version with the toolbox, but we did figure out the "direct" compilation using a combination of mingw and cmake. (Again, hopefully)

The docs restructure is meant to clarify to other Windows users how they can "easily" compile ROSCO. I also corrected a few typos and incorrect commands for Windows (e.g., it's mingw32-make, not make install, cp is not a command on Windows, etc.).

Credit to Stephan and Thea, who are working with the controller and gave good hints as to how we could finally get something to compile.

jennirinker commented 3 years ago

ping @dzalkind @nikhar-abbas

nikhar-abbas commented 3 years ago

@jennirinker thanks for this - will take a look in more detail this week, but it does all look good at first glance. Both @dzalkind and I use a mac as our primary machine, so need to recruit some help to verify everything.

One thing - could you change this to be pulled into the develop branch, and update the code accordingly?

jennirinker commented 3 years ago

Definitely I can do that. :)

jennirinker commented 3 years ago

Note for transparency: I've changed the 32-bit mingw installation instructions to point to this nice webpage instead of to the MinGW landing page. Although the page is less "official" than the mingw website, it actually offers useful guidance on installing/configuring.

I look forward to the day when HAWC2 is 64-bit and we can just use the conda toolchain.

nikhar-abbas commented 3 years ago

@jennirinker, sorry to bug you on this again - could you merge in the most recent updates to develop? The tests should pass once that is merged.

jennirinker commented 3 years ago

@nikhar-abbas I've rebased off of develop and integrated almost all of @rafmudaf's comments. (One of the comments I'd prefer to implement in another PR if we decide it's needed.) As a note, I did totally biff the rebase and now my commit history is pretty messy, sorry about that. Hopefully the changes are still understandable.

nikhar-abbas commented 3 years ago

@jennirinker Thanks for this - certainly helps clarify a lot!