bhitov / spectral-workbench Goto Github PK

==========================
PLOTS Spectral Workbench
Copyright 2011 Public Laboratory
publiclaboratory.org
==========================

PLOTS Spectral Workbench is a set of open-source tools to perform low-cost spectral analysis and to share those results online. The suite is provided in several folders, each corresponding to a separate tool:

/spectrometry_kit - A Processing.org-based desktop environment for collecting spectral readings from a connected USB webcam-based spectrometer.
	- Read about how to build and use your own spectrometer with this software here: http://publiclaboratory.org/tool/spectrometer
	- See examples of output here: http://publiclaboratory.org/notes/warren/9-3-2011/several-new-spectra-food-samples

/webserver - A Ruby on Rails web application for publishing, archiving, discussing, and analyzing spectra online.
	- Currently under heavy development

==========================
LICENSE
==========================

PLOTS Spectral Workbench is free software: you can redistribute it and/or modify
it under the terms of the GNU General Public License as published by
the Free Software Foundation, either version 3 of the License, or
(at your option) any later version.

PLOTS Spectral Workbench is distributed in the hope that it will be useful,
but WITHOUT ANY WARRANTY; without even the implied warranty of
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
GNU General Public License for more details.

You should have received a copy of the GNU General Public License
along with PLOTS Spectral Workbench.  If not, see <http://www.gnu.org/licenses/>.

==========================
BUGS AND SUPPORT
==========================

To report bugs and request features, please use the GitHub issue tracker provided at http://github.com/jywarren/spectral_workbench/issues 

For additional support, join the Public Laboratory website and mailing list at http://publiclaboratory.org or for urgent requests, email [email protected]

==========================
DEVELOPERS
==========================

Development is occurring at https://github.com/jywarren/spectral-workbench/; please fork and submit pull requests.

To edit the Processing code, you need Rake (http://rake.rubyforge.org/, http://rubyforge.org/projects/rake) and Processing (tested on 1.5.x).

* Enter spectrometry_kit/src/ and type "rake build"
* To continuousl build, type "rake autobuild"
* Your changes in src/ will be compiled into spectrometry_kit/spectrometry_kit.pde as you save.
* It's helpful to check the "external editor" box in Processing's preferences.
* Run the code from within Processing