sampledoc

Installing SitePainter

SitePainter is a desktop application that runs in Firefox >= 4.0.0 but we recommend using the latest stable version. Download the SitePainter release package, unzip the downloaded file and open the index.html file inside the new created folder (make sure that you are using Firefox!).

Dependencies required for all features of SitePainter

Stable Pre-Release

Currently the most stable version of SitePainter is our 1.1 release, which you can download from here.

Latest Development Version

To get the latest development version of SitePainter, you should check it out of our GitHub repository. While this code is subject to changes in interface and hasn’t been as extensively tested as the release version, it will provide access to the latest and greatest SitePainter features. The official web documentation is likely to be out-of-date with respect to the development software. Check out the latest version of SitePainter using git with the commands:

git clone git://github.com/biocore/SitePainter.git

git users should periodically update SitePainter by using the following command:

git pull

Building The SitePainter Documentation

If you are using the development version of SitePainter, you may want to build the documentation locally for access to the latest version. You can change to the sitepainter/doc_source directory and run:

make html

We try to update the documentation as we update the code, but git users may notice some discrepancies. After building the documentation, you can view it in a web browser by opening the file sitepainter/doc_source/_build/html/index.html. You may want to bookmark that page for easy access.