haidark / plateproj Goto Github PK

README for PlateProject - Updated 8/12/15 by Haidar Khan

Instructions for WINDOWS:
- Here is how to run the program:
1) Install Python 3.4.3 from here: https://www.python.org/downloads/
    1a) During installation, check the box labeled "Add python to PATH"
2) Navigate to the 'PlateProj\python\' directory(in this repository)
3) Double click the 'PlateProj.py' file
    3a) If an "Open With" dialog pops up, select "Python Launcher for Windows (Console)"
    3b) alternatively, open a command prompt in the 'PlateProj\python\' directory
        and enter 'python PlateProj.py <xml filename>'

Instructions for MAC:
- Here is how to run the program:
1) Navigate to the 'PlateProj\python\' directory(in this repository)
2) Open a terminal in the 'PlateProj\python\' directory
3) Enter 'python PlateProj.py <xml filename>'

- A windows executable will be available soon.
+-- This is dropped, its easier for the client to install python
    and just double click on the script.

- Work on a GUI is in progress...

DEVELOPER NOTES:

Goal: Convert data from format outputted by a laboratory machine to an easier format to manipulate

Collaborators: Haidar Khan; Babar Khan, Azer Khan, Shuaib Peters, Badar Khan

The project is divided into three main components:

--Parser module
-Parses input data and create data objects

--Data Structure
-Defines a general class of objects for data storage

--Printer Module
-Prints data objects to an output file in any desired format