File	Date	Author	Commit
doc	2012-02-27	oepen	[d628ec] -Bump up the version number in the documentation
m4	2012-02-27	oepen	[f77332] Moved developement to trunk directory
src	2012-07-09	oepen	[9dedce] Added wrapper for EAC_CTX_print_private
AUTHORS	2012-02-27	oepen	[f52fd6] -Documentation fix: Only check out trunk if you...
COPYING	2012-09-07	Dominik	[5eea1e] COPYING is no longer a symlink
ChangeLog	2012-02-27	oepen	[f77332] Moved developement to trunk directory
Makefile.am	2012-02-27	oepen	[f77332] Moved developement to trunk directory
NEWS	2012-02-27	oepen	[f77332] Moved developement to trunk directory
README	2012-02-27	oepen	[d628ec] -Bump up the version number in the documentation
autogen.sh	2012-02-27	oepen	[f77332] Moved developement to trunk directory
configure.ac	2012-05-02	oepen	[75490b]

Read Me

Welcome to pyPACE
=================

pyPACE is a python wrapper for the `OpenPACE <http://openpace.sourceforge.net>`_
library. It's implemented using `SWIG <http://swig.org>`_ and therefore its's
easily portable to lots of different languages.

.. toctree::

    python_api.rst

In order to use pyPACE you need to:

- Download and build OpenPACE
- Build pyPACE (needs to be linked against OpenPACE)
- Install pyPACE using distutils

Downloading pyPACE
------------------

You can download the current version (0.2) `here <https://downloads.sourceforge.net/project/pypace/pypace-0.2.tar.gz?r=https%3A%2F%2Fsourceforge.net%2Fprojects%2Fpypace%2F&ts=1330336368&use_mirror=ignum>`_.

If you want to retrieve the latest development version of pyPACE you can check
out the svn repository:

``svn co https://pypace.svn.sourceforge.net/svnroot/pypace/trunk pypace``


Building pyPACE
---------------

Dependencies
^^^^^^^^^^^^

In order to build pyPACE you need to install the following packages:

- autoconf
- libtool
- gcc
- python-dev
- swig

Compiling
^^^^^^^^^

Once all the dependencies are installed, configuring and compiling pypace is easy::

    autoreconf -vsi
    ./configure OPENSSL_LIBS="-L/path/to/openpace/libs -lcrypto" OPENSSL_CFLAGS"-I/path/to/openpace/includes"
    make
    make install

Running pyPACE
^^^^^^^^^^^^^^

In order to run programs that use pyPACE you have to set up the `LD_LIBRARY_PATH`
environment variable to point to the OpenPACE library. One way to do this is:

``export LD_LIBRARY_PATH=$LD_LIBRARY_PATH:/path/to/openpace/libs``

In order to test your installation you can use the `test.py` script included in
pyPACE. Simply run the following command:

``python src/python/test.py``

JPace
-----

JPace is an (experimental) alternative to pyPACE for those who prefer to use
Java instead of python. In order to build JPace you need to pass the 
``--enable-java`` parameter to configure. You also need to set the `JAVAC`
environment variable to your preferred java compiler.