From fa5dcb3bb5c021e6fcf02cc3f3e1781ef759ee04 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?=C3=89ric=20Piel?= Date: Tue, 17 Jul 2012 17:19:09 +0200 Subject: [PATCH] update documentation retested installation of andor sdk 2.93 --- README.txt | 12 ++++-------- doc/INSTALL.txt | 33 +++++++++++++++++++++++++++++++-- driver/README.txt | 23 ----------------------- 3 files changed, 35 insertions(+), 33 deletions(-) delete mode 100644 driver/README.txt diff --git a/README.txt b/README.txt index dacee0bf8c..eed02acb3e 100644 --- a/README.txt +++ b/README.txt @@ -1,14 +1,8 @@ Odemis, Open Delmic Microscope Software = Requirements = -Linux (tested on Ubuntu 11.10 32-bits) or Windows (7) -Python (v2.7) with python-wxgtk2.8 (wxPython), python-imaging (PIL), -python-yaml (PyYaml), python-gdal (GDAL), python-serial (pyserial) - -For Andor Neo camera support: -Andor SDK v3.3+ -- on Linux, the bitflow driver has to be reinstalled (recompiled) each time the kernel is updated. -For Andor Clara camera support: -Andor SDK v2.97 -- on Linux/Ubuntu you need to install libusb-dev (so that whereis reports libusb.so). Also the the permissions of all the files must be allowed for normal user: everything is installed by default as root only, so nothing can work from the normal user account. +Linux (tested on Ubuntu 12.04 32-bits) or Windows (7) +Python (v2.7) = Installation = See the doc/INSTALL.txt document for the complete installation procedure. @@ -22,6 +16,8 @@ See "odemisd --help" for information. For example: PYTHONPATH=./:../Pyro4/src/ ./odemisd/main.py --daemonize --log-level=2 odemisd/test/optical-sim.odm.yaml +To use the command line interface use: +PYTHONPATH=./:../Pyro4/src/ ./cli/main.py --help = License = GPLv2, see the LICENSE.txt file for the complete license. diff --git a/doc/INSTALL.txt b/doc/INSTALL.txt index a9aa1b4737..e6eafc5359 100644 --- a/doc/INSTALL.txt +++ b/doc/INSTALL.txt @@ -2,13 +2,42 @@ How to install Odemis = Installing the dependencies = You need Ubuntu 12.04 (x86 - 32 bits). -sudo apt-get python-wxgtk2.8 python-imaging python-yaml python-gdal python-serial +sudo apt-get python-wxgtk2.8 python-imaging python-yaml python-gdal python-serial python-zmq = Installing Odemis = -git clone git@github.com:pieleric/odemis.git +git clone git@github.com:delmic/Pyro4.git +git clone git@github.com:delmic/odemis.git + +sudo mkdir /var/run/odemisd/ +chmod a+rwx /var/run/odemisd/ + += Installing the vendor device drivers = +== Andor Clara camera == +Install Andor SDK v2.93+ (USB product) +On Linux/Ubuntu you need to install libusb-dev (so that whereis reports libusb.so). +Also the the permissions of all the files must be allowed for normal user: everything is installed by default as root only, so nothing can work from the normal user account. See /usr/local/*/*andor* +Finally, fix /etc/udev/rules.d/andor.rules to read as: +ATTRS{idVendor}=="136e", MODE="0666" +For example: +sudo gedit /etc/udev/rules.d/andor.rules +sudo udevadm control --reload-rules + + +== Andor Neo camera == +Install Andor SDK v3.3+ +On Linux, the bitflow driver has to be reinstalled (recompiled) each time the kernel is updated. + +== Physik Instrumente C-170 piezo-motor controllers == +Nothing specific. Make sure that the normal user has permissions to access the serial port. +For example, if it is a USB serial port adapter check the permissions of /dev/ttyUSB0. = Configuring the instantiation file = This file describes the available hardware for Odemis. Basically, it list for each hardware, which driver to use and the parameters required. See the backend specification for precise syntax and example files. + + + + + diff --git a/driver/README.txt b/driver/README.txt deleted file mode 100644 index 35f42a64ae..0000000000 --- a/driver/README.txt +++ /dev/null @@ -1,23 +0,0 @@ -Delmic Acquisition Software for Physik Instrumente C-170 piezo-motor controllers - -= Requirements = -Linux or Windows -Python (v2.7) with pySerial - -= Basic usage = -dacontrol.py is the command line interface to the PIRedStone python class. - -Run as "./dacontrol.py ...", with ... replaced by the correct arguments. -See "./dacontrol.py --help" for information. - -Basically there are 2 modes: -* command mode: move the stage -* test: tests the connection to the motor controller over the serial line. - - -= License = -GPLv2 - -= Testing = -To test the software, connect the controller(s) and run pi_test.py. It is not necessary -to have the motors connected to the controllers, but if they are, they will _move_ (a lot).