README

ChemMine Tools: an Open Source Web Framework for Small Molecule Analysis

Look at bootstrap.sh for software dependencies and installation
instructions.

To get started with a development box:

1) Download and install Vagrant and Virtualbox from here:
    http://www.vagrantup.com
    https://www.virtualbox.org
2) Clone this repo and cd into it:
    git clone https://github.com/TylerBackman/chemminetools.git
    cd chemminetools
3) Run this command to provision and launch your devel environment: 
    vagrant up
4) You will now have a running chemmine tools at:
    http://127.0.0.1:8080/myCompounds/addCompounds/
5) Note that this server is very insecure, as the private keys and passwords
come from the example file. You should block it with a firewall until you secure it
for production! Also, note that some tools (such as EI search) require large
databases and won't work with an out of the box devel container.
6) Shut down vagrant (re-run 'vagrant up' to relaunch):
    vagrant halt

Compatible Browsers:
Google Chrome 25
Safari 5 
Firefox 17

Incompatible Browsers:
Opera 12 (works but with minor issues with similarity workbench and table viewer)
Internet Explorer 6, 8, 10 (9 not tested) 

License:
(C) 2013-2014 Tyler Backman, Yiqun Cao, and Thomas Girke (the authors)

This program 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.

This program 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 this program.  If not, see <http://www.gnu.org/licenses/>.