1. Installing QUAC¶

1.1. PyPI and virtualenv (recommended)¶

This method installs QUAC and its Python dependencies inside a virtual environment with its own Python binary and libraries. This isolates QUAC from other Python stuff you may have on your system, reducing conflicts.

These instructions assume that virtualenvs are installed under ~/.virtualenvs and QUAC will be installed in ~/quac.

1. Install prerequisites. The following are required:

   • Git.
   • Python 3.4 including development libraries.
   • virtualenv and virtualenvwrapper.
   • Programs and libraries needed by Python packages (e.g., HDF5 command-line tools, GEOS). Installation failures along the way should guide you here. Known .deb packages needed on Ubuntu Trusty:
     • cmdtest
     • hdf5-tools
     • libdgal-dev
     • python-pip
     • python-virtualenv
     • virtualenvwrapper

   Installation of these things is outside the scope of this guide.

2. Download QUAC using Git:

   $ cd
   $ git clone https://github.com/reidpr/quac.git
   $ cd quac
   

3. Create virtual environment, and then deactivate it because you are going to be messing with it:

   $ mkvirtualenv --python=/usr/bin/python3 quac
   $ deactivate
   

4. Add to virtualenv post-activate hook (~/.virtualenvs/quac/bin/postactivate):

   OLD_PYTHONPATH="$PYTHONPATH"
   export PYTHONPATH=~/quac/lib
   OLD_PATH="$PATH"
   export PATH=~/tw/quac/bin:$PATH
   

5. Add to virtualenv pre-deactivate hook (~/.virtualenvs/quac/bin/predeactivate):

   export PYTHONPATH="$OLD_PYTHONPATH"
   export PATH="$OLD_PATH"
   

6. Activate virtual environment:

   $ workon quac
   

7. Install GDAL Python bindings (adjust include paths and version if needed):

   $ CPLUS_INCLUDE_PATH=/usr/include/gdal C_INCLUDE_PATH=/usr/include/gdal pip install gdal==1.10.0
   

   This must be done manually because the bindings have a buggy include path. Note also that the version must match the system GDAL libraries or the build will fail in strange ways.

8. Install APSW (alternate SQLite bindings). This cannot be done using pip because the install script requires options, and pip cannot provide them. For example (use the latest version):

   $ pushd /usr/local/src
   $ wget https://github.com/rogerbinns/apsw/releases/download/3.8.9-r1/apsw-3.8.9-r1.zip
   $ unzip apsw-3.8.9-r1.zip
   $ cd apsw-3.8.9-r1
   $ python setup.py fetch --all build --enable-all-extensions install test
   $ popd
   

   The tests take 5-10 minutes to run; you can omit if you want to live dangerously, or proceed in another terminal while they run.

   You can also install APSW at the system level and configure your virtualenv to pass system modules through.

   Warning

   APSW version 3.8.9, and hence SQLite 3.8.9, or higher is required. This is because prior versions of SQLite incorrectly enforce memory limits that QUAC depends on, leading to a memory leak. See the 3rd item in the release notes and the relevant commit.

9. Install remaining Python dependencies:

   $ pip install -r requirements.txt
   

10. Build executables and the documentation:

    $ make
    

11. Run the tests (this is actually pretty important, as it tells you whether you’ve installed all the dependencies correctly):

    $ ./runtests
    

    Some tests require additional data or resources; if they are not available, then the tests are skipped.

    (While some parts of QUAC will work if some tests fail, we recommend installing everything necessary to make them pass, as this will make your life much easier going forward.)

1.2. Self-compile¶

This installation method is useful when internet access is available and/or system libraries are insufficient. Root access is not required.

$ pip install pip2pi

$ deactivate          # if you have a virtualenv active
$ cd $QUACBASE
$ ./misc/manual-download

$ cd $QUACBASE
$ tar xf deps.tar.gz
$ ./misc/manual-install

$ ./runtests