Skip to content

Commit

Permalink
Update Installation Instructions (#742)
Browse files Browse the repository at this point in the history
* Update flow_setup.rst: add python setup.py develop

We need the line "python setup.py develop" for the SUMO GUI to load. Otherwise, we'll get a ModuleNotFound Error.

* Update flow_setup.rst

I've moved the command "python setup.py develop" up to the setup instructions itself (i.e. directly after activating the conda environment).

I've also updated "source activate" and "source deactivate" to "conda activate" and "conda deactivate", since "source" no longer works for Anaconda versions >= 4.6.

Finally, I've deleted the repeated instructions on "Testing your installation" for RLlib. There were two of the same sections for Testing your installation for RLlib, and the content of second one was just a shortened version of the first one.
  • Loading branch information
kevin-thankyou-lin authored and eugenevinitsky committed Oct 1, 2019
1 parent 180e063 commit fc76d03
Showing 1 changed file with 5 additions and 24 deletions.
29 changes: 5 additions & 24 deletions docs/source/flow_setup.rst
Original file line number Diff line number Diff line change
Expand Up @@ -46,7 +46,8 @@ script. Be sure to run the below commands from ``/path/to/flow``.

# create a conda environment
conda env create -f environment.yml
source activate flow
conda activate flow
python setup.py develop

If the conda install fails, you can also install the requirements using pip by calling

Expand Down Expand Up @@ -118,12 +119,12 @@ sure to enter your conda environment by typing:

::

source activate flow
conda activate flow

Let’s see some traffic action:

::

python examples/sumo/sugiyama.py

Running the following should result in the loading of the SUMO GUI.
Expand Down Expand Up @@ -248,7 +249,7 @@ To run any of the RL examples, make sure to run

::

source activate flow
conda activate flow

In order to test run an Flow experiment in RLlib, try the following command:

Expand Down Expand Up @@ -282,26 +283,6 @@ jobs from there.
ray teardown scripts/ray_autoscale.yaml


Testing your installation
~~~~~~~~~~~~~~~~~~~~~~~~~

To run any of the RL examples, make sure to run

::

source activate flow

In order to test run an Flow experiment in rllib, try the following
command:

::

python examples/rllib/stabilizing_the_ring.py

If it does not fail, this means that you have Flow properly configured with
rllib.


(Optional) Direct install of SUMO from GitHub
---------------------------------------------

Expand Down

0 comments on commit fc76d03

Please sign in to comment.