millersd / mslice_2.0 Goto Github PK

################################################################################

June 18, 2014

README.TXT file pertaining to the MSlice PyQt development effort.

This README is intended to assist with understanding the organizational structure of the MSlice software suite.

Main program: MSlice.pyw GUI constructor import for main: MSlice.py GUI construction file: MSlice.ui

Child main program: WorkspaceComposerMain.py GUI constructor import: WorkspaceComposer.py GUI construction file: WorkspaceComposer.ui

Child main program MPLPowderCutMain.py GUI constructor import: MPLPowderCut.py GUI construction file: MPLPowderCut.ui

Child main program SliceViewer.py This SliceViewer has been extracted from MantidPlot

Subtle note that the pattern of using .pyw was not used for WorkspaceComposer as at this point it wasn't clear to the developer how to import a .pyw file as this seemed a minor issue easy to circumvent.

Qt Designer has been used to produce the .ui files. The python utility pyuic4 is used to convert the .ui file to a .py file. The main programs have been developed following the pattern of importing the *.py files produced via Qt Designer and pyuic4.

Following python convention, the above mentioned .py and .pyw files should be co-located within the same directory, then from a terminal command prompt type the following command to launch the MSlice application: python MSlice.pyw

The current version of MSlice has been built based upon python 2.7 and PyQt4

Running the main program often creates corresponding .pyc files which are in 'Compiled Python' format. Subsequent runs of the main program can utilize these .pyc files thus shortening the initialization time for running the application. Largely, these .pyc files can be ignored and are not in github

Currently many features remain to be implemented though the application runs sufficiently to demonstrate the concepts of using file based Mantid workspaces as the data model.

For convenience, a powder test data set (zrh_1000.nxs) has been to the repo to give the user some data to use with the application.

Python imports for these applications:

• sys, os, time
• PyQt4
• psutil
• numpy
• matplotlib
• mantid.simpleapi
• pyplot