Merge branch 'documentation' into develop

README.rst

@@ -26,11 +26,17 @@ LINKS / DEPENDENCIES
 
 All dependencies and User Manual are available from www.tango-controls.org:
 
-Tango
-PyTango
-Taurus
-Fandango
+* Tango: https://github.com/tango-controls/cppTango
+* PyTango: https://github.com/tango-controls/pytango
+* Taurus: https://github.com/taurus-org/taurus
+* Fandango: https://github.com/tango-controls/fandango
 
+Optional dependencies:
+
+* https://github.com/tango-controls/SimulatorDS
+* https://github.com/tango-controls/PANIC
+* https://github.com/tango-controls/PyTangoArchiving
+* ...
 INSTALLING:
 ===========
 

examples/elinac/README.rst

@@ -2,12 +2,15 @@
 Execute the ELinac simulation
 =============================
 
-PyTango and Taurus must be installed
+REQUISITES: PyTango and Taurus must be installed::
+
+  > Debian/Ubuntu: sudo apt-get install tango-pytango python-taurus
+  > OpenSUSE: sudo zypper install tango-pytango python-taurus
 
 In addition, get latest fandango and SimulatorDS::
 
-  > git clone https://github.com/tango-controls/fandango fandango.git
-  > git clone https://github.com/tango-controls/SimulatorDS
+  > git clone -b develop https://github.com/tango-controls/fandango fandango.git
+  > git clone -b develop https://github.com/tango-controls/SimulatorDS
   
 Install them using setup.py or just add folders to PATH::
 
@@ -16,7 +19,7 @@ Install them using setup.py or just add folders to PATH::
 
 Get Vacca::
 
-  > git clone https://github.com/tango-controls/vacca vacca.git
+  > git clone -b develop https://github.com/tango-controls/vacca vacca.git
   > export PATH=$(pwd)/vacca.git/bin:$PATH
   > export PYTHONPATH=$(pwd)/vacca.git:$PYTHONPATH
   > cd vacca.git/examples/elinac
@@ -27,28 +30,28 @@ using SimulatorDS ::
   > ipython
   : import SimulatorDS.gen_simulation as gs
   : gs.generate_class_properties(all_rw=True)
-  : gs.create_simulators('ui_attribute_values.pck',instance='elinac',
-       tango_host='127.0.0.1')
+  : host = gs.fandango.get_tango_host().split(':')[0]
+  : gs.create_simulators('ui_attribute_values.pck',instance='elinac',tango_host=host)
+  # Press "yes" when asked to override properties. 
   : Ctrl+D
 
-If you have starter, SimulatorDS and fandango/scripts in PATH, let's 
-launch the simulators::
-
-Using Starter and fandango/scripts::
+Launch the simulators using DynamicDS script::
 
-  > tango_servers start "DynamicDS/elin*"
+ > DynamicDS elinac >/dev/null &
+ 
+Check that they started properly::
 
- Or directly running the .py script::
-
-  > python ...../SimulatorDS.py elin &
+ >  tango_servers states DynamicDS/elinac
 
 Last, launch VACCA::
 
   > vaccagui elinac.py
 
 .. image:: screenshot.png
 
-From this point you can select devices from the tree or synoptic, plot values, interact with attributes/commands or start/stop/reload devices and its properties using the right click menus.
+Depending on your OS version you may get some QString exceptions at startup; just click on "Ignore" as these messages will appear only the first time you execute the application.
+
+From this point you can select devices from the tree or synoptic, plot values, interact with attributes/commands or start/stop/reload devices and its properties using the right click menus. You can use the properties panel to edit the values of the attributes as you wish; use right-click or the updateDynamicAttributes command to update the simulated values.
 
 If panic and PyTangoArchiving are available, the AlarmGUI and ArchivingBrowser widgets can be added to the perspective for a richer functionality.