======================================================================================
		CENTRO DE TECNOLOGÍA MÉDICA (CTM)                       **************
		UNIVERSITY OF LAS PALMAS DE GRAN CANARIA                **************
		http://www.ctm.ulpgc.es                                 **************
======================================================================================



			
*****  PLEASE READ THE "LICENSE.txt" FILE FOR INFORMATION ABOUT THE LICENSE OF THIS PRODUCT  *****




///////////////////////////////////////////////////////////////////////////////////////////////////


The ESQUI Project distribution contains the following folders:


- ESQUI folder:

	- ColDetect: contains the source code for collision detection library.
	- Colisions: contains the source code for managing the collisions library.
	- Comun: Contains useful code for ESQUI.
	- Haptic: Contains code for controlling Haptics devices.
	- BEM: Contains useful mathematical functions.
	- Tools: Contains code useful for surgical tools management.
	- T2Mesh: Contains code for biomechanic model.
	- TCL: Contains the Tcl code that run the system
	- Wrapping: Wrapper for Tcl.
	- Docs: Contains the source code documentation .
	- misc: Contains the Python scripts used to export the models from Blender.

- Videos folder:

	- Contains two video demo of the system.
	
Installing ESQUI

 ESQUI has been developed using vtk 4.4.2 and tcl/tk 8.4.13.
 
	To install ESQUI it's needed to have a CMake (http://www.cmake.org) and vtk (http://www.vtk.org) installation wrapped by tcl (http://tcl.tk), and follow the next steps:
	
1- Download the source code and unzip.

2- The folder "Haptic" contains the code developed to drive haptic device. The haptic device used is the LSW from Immersion Corporation. 
If you will USE this device you'll need to delete the "#" at first of the Cmakelist.txt file line corresponding to the Haptic project generarion (inside of the Subdirs body) to avoid future problems when linking. Also follow the indications included in the main.tcl file to use the LSW haptic device.

3- Run CMake and set the "Where is the source code" value to "MyFolder/FS/ESQUI".

4- Compile the project.

5- Set the environment variables (i.e. LD_LIBRARY_PATH).