Users:
Developers:
The recommended way to install peppy on all systems (unless you want to develop plugins) is to use easy_install to install peppy into your python site-packages directory.
Easy Install
The de-facto package management system in Python is setuptools . Setuptools provides a program called easy_install that manages dependencies among packages.
You'll have to have python and wxPython installed on your system for this to work. If you don't have python and wxPython installed, you can try one of the binary installers below.
- Install python following these instructions for your platform.
- Install wxpython following these instructions for your platform.
If you don't have setuptools installed, you can bootstrap it by downloading the ez_setup.py script and running it. This will add setuptools to your python site-packages directory and place the easy_install script in your system PATH.
Once all the prerequisites are satisfied, all you need to do to install peppy is:
easy_install -U peppy
which will install or upgrade peppy in your site-packages directory. you may need to be the root user (or have administrator privileges on Windows) to do this.
The setup procedure also places a startup program named "peppy" in a directory that should by default be included in your system PATH environment. (Typically, this is the same directory that python itself is installed into.)
Peppy is updated at the Python Package Index, so this install method will always get the latest version of the code.
Binary Installers
Binary installers are self-contained: they do not depend on python or wxpython being installed on the host system. Everything you need to run peppy (including optional modules like pyenchant, NumPy, and GDAL) is contained within the installer.
Note 1: Plugins aren't available when using binary installers. If you're interested in developing plugins or extending the functionality of peppy, you should install from source code.
Note 2: there is no installer for unix-like operating systems. You should install using one of the other methods.
Windows Installer
Mac OSX Installer
coming soon (hopefully)...
Source Code for Developers
There are two ways to get the source code: download the current release, or use subversion to get the current development tree. In both cases, however, Python and the wxPython widget toolkit must be installed on your system in order to run peppy. (See above.)
- Recommended: download current release: peppy-0.16.0.tar.bz2
- If you're using unix, linux or Mac OSX:
- tar xvf peppy-0.16.0.tar.bz2
- cd peppy-0.16.0
- python run.py
- If you're using windows:
- extract the archive using winzip, 7zip, or another extractor
- go to the extracted folder peppy-0.16.0
- double-click on run.py
- Advanced: checkout using svn to get the current development tree.
- If you're using unix or linux:
- svn co http://svn.flipturn.org/peppy/trunk peppy
- cd peppy
- python run.py
- Browse: look at the source code before you download using svn or trac.
Peppy is designed so that you can develop and test right out of the directory you downloaded. Nothing has to be installed unless you are on OS X.
OS X development
On OS X, you can run the script setup_mac.py to create symbolic links in the python site-packages directory that will allow you to develop peppy in place but have a nice peppy icon instead of the rocketship launcher icon. Simply run:
python setup_mac.py py2app -A
to create a .dmg that you can use just like a regular disk image, including installing peppy in the dock for use with drag and drop file opening.
Optional Modules
Peppy has some additional capability that can be used if the following optional modules are installed:
- pyenchant
- If pyenchant is installed, text-based major modes will use it to provide on-the-fly spell checking.
- NumPy 1.0
- Some of the optional major modes like the Hyperspectral Image Viewer and the Aptus fractal viewer require NumPy, but note that NumPy is not required to run peppy for normal editing.
- GDAL 1.5
- The Hyperspectral Image Viewer can also use the GDAL 1.5 libraries to read images. GDAL supports a wide range of image formats, including compressed formats. Note that you need the new style swig bindings (which are built by default in GDAL 1.5).
- SciPy 0.6
- For even more functionality in the Hyperspectral Image
Viewer, you can install the SciPy library. SciPy provides a
huge suite of mathematical utility functions and is used in
several image enhancement commands. However, it is a bit of a complicated
install, involving compiling some libraries by hand.
A problem that plagued me for a while was that the "python setup.py install" stage was picking up libblas and liblapack from the system's /usr/lib directory, and RedHat prior to early 2007 supplied incomplete libraries. I had to replace these system libraries with my just-built libraries, because setup.py seemed to ignore the paths I specified for BLAS and LAPACK as shown in the instructions on the webpage above.
Older Releases
Older releases are archived here.