Update README.md

parent c5d72abc
......@@ -2,25 +2,16 @@
Python module to control a Meca500 robot over TCP/IP.
The Meca500 robot has a web interface for control, but it can only be used for basic testing since it does not allow for anything remotely complicated (such as loops). The MecaRobot class controls the robot by sending it commands overs TCP/IP.
The MecaRobotForDosimetry adapts the MecaRobot class for scintillation dosimetry. It tracks each scintillator's position and the signal they emit.
The MecaRobotForDosimetry adapts the MecaRobot class for scintillation dosimetry. It tracks each scintillator's position in relation to the brachytherapy source.
The robot allows for a simulation mode, in which the actual robot does not move but we can still see the animation on the web interface. It is possible to add a 3D model of the tool fixed at the end of the robot so we can see it on the simulation (here the mPSD_holder.stl), as well as a 3D model of the environnement (here to source_catheter_holder.stl).
## User guide
The user guide (user_guide.md) can be used as a quick way to get started using the Meca500 robot and the MecaRobot Python module.
## Documentation
The complete Meca500 user guide written by the manufacturer can be found [here](https://www.mecademic.com/Documentation/Meca500-R3-User-Manual.pdf) and [here](https://www.mecademic.com/Documentation/Meca500-R3-Programming-Manual.pdf).
The complete documentation for this Python module can be found in the documentation.md file.
\ No newline at end of file
Markdown is supported
0% or
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment