-----------------------
0.CONTENTS
-----------------------
1.ABOUT
2.LICENSE
3.THIRD-PARTY CODE
3.INSTALLATION
4.USAGE
4.FEEDBACK AND BUG REPORTS

-----------------------
1.ABOUT
-----------------------
SpecMate is a graphical tool to analyse spectroscopic data. Currently it offers three main features: 1) Background removal, 2) Subtraction of reference datasets, 3) Peak fitting(Gauss/Lorentz/Voigt).  
The program is written in python (based on numpy/scipy, wxWidgets, and  wxmpl). It has been tested on GNU/Linux (debian wheezy) only.   
-----------------------
LICENSE
-----------------------
The entire program is licensed under the GNU GENERAL PUBLIC LICENSE. See LICENSE file for details.
There is a copy of "wxmpl.py" distributed along with this package, since it is not yet available in any stabe version of debian. Wxmpl has its own README and LICENSE. Please see README_LICENSE_WXMPL for details. 

-----------------------
THIRD-PARTY CODE
-----------------------
1) There is a copy of "wxmpl.py" ((http://csrri.iit.edu/~wxmpl/; called "copy_of_wxmpl.py" here) distributed along with this package, since it is not yet available in stable versions of many GNU/Linux distributions. The file will only be used if wxmpl is not installed on the system. 
wxmpl is published under the MIT License. The original README and LICENSE are distributed along with this package in README_LICENSE_WXMPL.

2) There are a few lines of code taken from an example file from "matplotlib.org". The part is indicated in the doc-string.

-----------------------
INSTALLATION
-----------------------
1.Make sure you have python, python-wx, python-matplotlib, python-wxmpl, and scipy installed. On a debian-based system "apt-get install python-wxmpl python-wxgtk2.8 python-scipy" should do the trick. If python-wxpml is not available in your distribution it will probably work without wxmpl, but all other packages have to be in place. 
2.Extract the tarball to a directory of your choice, the directory "SpecMate-x.x.x/" will be created. cd into it and run either:
"python setup.py install" (as root, for a system-wide installation)
or
"python setup.py install --user" (as normal user, for installation in your home-dir)
In the later case, you'll have to find out what the default path for python user-scripts is on your system. On debian it is "~/.local/bin/", i.e. you'll have to run ".local/bin/specmate" assuming you are in your home dir. 

-----------------------
USAGE
-----------------------
Here's a brief "quickstart guide":
1. Always start by opening the spectrum that you want to analyse: 
Goto File/Open Spectrum and select an ASCII datafile with at least 2 columns separated by whitespace character (e.g. TAB or space(s) ). The first column will be treated as X-Axis, the second as Y-Axis. All other columns will be ignored.
2. If you want to remove the background from your spectrum ...

3. If you want to add a "reference spectrum", i.e. a second spectrum that you want to compare your (main) spectrum to, ...
 
4. If you want to add a peak ...

5. ... Fit ...

6. Exporting ...
-----------------------
FEEDBACK AND BUGS
-----------------------
Your comments and bug reports are very much appreciated:
specmate@posteo.de

