Merge pull request #74 from jerryz123/gym_submodule

Submoduled gym environments

.gitmodules

@@ -0,0 +1,3 @@
+[submodule "gym_fluids"]
+	path = gym_fluids
+	url = https://github.com/BerkeleyAutomation/gym_fluids.git

README.md

@@ -2,11 +2,22 @@
 
 # FLUIDS 2.0
 
-The core FLUIDS simulator. For a simpler OpenAI Gym interface see [https://www.github.com/jerryz123/gym_fluids.git](https://www.github.com/jerryz123/gym_fluids.git)
+The core FLUIDS simulator.
 
+To install from source, 
 ```
 pip3 install -e .
 ```
 
 For examples see `examples/fluids_test.py`.
 
+## Gym Environment
+
+The FLUIDS Gym environments provide a familiar interface to the FLUIDS simulator.
+
+To install from source,
+```
+git submodule update --init --recursive
+cd gym_fluids
+pip3 install -e .
+```

docs/source/installation.rst

@@ -10,7 +10,6 @@ The FLUIDS core simulator provides the core simulation environment. Currently on
 
    git clone https://github.com/BerkeleyAutomation/Urban_Driving_Simulator.git
    cd Urban_Driving_Simulator
-   git checkout v2
    pip3 install -e .
 
 Installing FLUIDS Gym Environments
@@ -20,6 +19,6 @@ The FLUIDS Gym Environment is compatible with agents designed for OpenAI's Gym b
 
 ::
    
-   git clone https://github.com/BerkeleyAutomation/gym_fluids.git
+   git submodule update --init --recursive
    cd gym_fluids
    pip3 install -e .