Updated clmc-service documentation

README.md

@@ -105,59 +105,3 @@ Then the package is installed
 Then the tests are run
 
 `vagrant --fixture=scripts -- ssh test-runner -- -tt "pytest -s --pyargs clmctest.scripts"`
-
-#### CLMC Service
-
-The CLMC service is implemented using the Pyramid framework. (currently under development)
-
-Before installing the CLMC service and its dependencies, it is recommended to use a virtual environment. To manage virtual
-environments, **virtualenvwrapper** can be used.
-
-```
-pip install virtualenvwrapper
-```
-
-To create a virtual environment use the **mkvirtualenv** command:
-
-```
-mkvirtualenv CLMC
-```
-
-When created, you should already be set to use the new virtual environment, but to make sure of this use the **workon** command:
-
-```
-workon CLMC
-```
-
-Now, any installed libraries will be specifically installed in this environment only. 
-
-To install and use the CLMC service locally, the easiest thing to do is to use **pip**. Navigate to the clmcservice root folder:
-```
-cd src/clmcservice
-```
-
-Test the CLMC service using **tox** along with the ***tox.ini*** configuration file. If tox is not installed run:
-
-```
-pip install tox
-```
-
-After it is installed, simply use the **tox** command:
-
-```
-tox
-```
-
-Then install the service in development mode.
-
-```
-pip install -e .
-```
-
-Finally, start the service on localhost by using pyramid's **pserve**:
-
-```
-pserve development.ini --reload
-```
-
-You should now be able to make requests to the CLMC service on http://localhost:8080/aggregator.
\ No newline at end of file

docs/clmc-service.md

@@ -21,7 +21,7 @@
 //      Created for Project :   FLAME
 -->
 
-# **Flame CLMC Service - API documentation**
+# **Flame CLMC Service Documentation**
 
 #### **Authors**
 
@@ -177,4 +177,58 @@ All source code, tests and configuration files of the service can be found in th
         with a **start** action.
         
         * The functionality of a request with a **restart** action is the same as the functionlity of a **stop** action
-        followed by a **start** action.
\ No newline at end of file
+        followed by a **start** action.
+        
+#### Installing and running the CLMC service (development mode)
+
+Before installing the CLMC service and its dependencies, it is recommended to use a python virtual environment. To easily
+manage virtual environments, **virtualenvwrapper** can be used.
+
+```
+pip install virtualenvwrapper
+```
+
+To create a virtual environment use the **mkvirtualenv** command:
+
+```
+mkvirtualenv CLMC
+```
+
+When created, you should already be set to use the new virtual environment, but to make sure of this use the **workon** command:
+
+```
+workon CLMC
+```
+
+Now, any installed libraries will be installed relative to this environment only. 
+
+The easiest way to install and use the CLMC service locally is to use **pip**. Navigate to the clmc-webservice folder:
+```
+cd src/clmc-webservice
+```
+
+Test the CLMC service using **tox** along with the ***tox.ini*** configuration file. If tox is not installed run:
+
+```
+pip install tox
+```
+
+After it is installed, simply use the **tox** command:
+
+```
+tox
+```
+
+Then install the service in development mode.
+
+```
+pip install -e .
+```
+
+Finally, start the service on localhost by using pyramid's **pserve**:
+
+```
+pserve development.ini --reload
+```
+
+You should now be able to make requests to the CLMC service on http://localhost:8080/aggregator/config and http://localhost:8080/aggregator/control.