Skip to content

Commit

Permalink
Update installation instructions -- draft
Browse files Browse the repository at this point in the history
  • Loading branch information
dzalkind committed May 8, 2024
1 parent 2c5696d commit c66ad25
Showing 1 changed file with 19 additions and 1 deletion.
20 changes: 19 additions & 1 deletion docs/source/install.rst
Original file line number Diff line number Diff line change
Expand Up @@ -23,17 +23,35 @@ Steps for the installation of the complete rosco toolset are:
conda create -y --name rosco-env python=3.10 # (Create a new environment named "rosco-env" that contains Python 3.8)
conda activate rosco-env # (Activate your "rosco-env" environment)
# Windows users sometimes get an error related to the SSL configuration; in this case, use
# Be sure to execute commands in an anaconda terminal rather than the windows command prompt
conda config --set ssl_verify no
# Install necessary compilers
conda install -y m2w64-toolchain libpython # windows
conda install compilers # unix
# If you intend to use ZeroMQ
brew install zeromq # mac
sudo apt install libzmq3-dev libzmq5 libczmq-dev libczmq4 # linux
2. Clone and Install the ROSCO toolbox with ROSCO controller

.. code-block:: bash
git clone https://github.com/NREL/ROSCO.git
cd ROSCO
pip install -e .
pip install -e . --no-deps
This step creates the rosco controller binary (:code:`libdiscon.so` (Linux), :code:`libdiscon.dylib` (Mac), or :code:`libdisscon.dll` (Windows)`) in the directory :code:`ROSCO/rosco/lib` and installs the python toolbox in the conda environment in the develop mode.

3. If for some reason the pip-based installation does not work, the conda environment can be created using

.. code-block:: bash
conda env update --file enviroment.yml
pip install -e . --no-deps
.. _rosco_controller:

Expand Down

0 comments on commit c66ad25

Please sign in to comment.