.. _downloads:

Download
========

.. contents::

Installation
------------

Using `Pip Installs Python (Pip) <http://www.pip-installer.org/en/latest/index.html>`_,
simply type::

    pip install http://www.igsor.net/research/nowhere/_downloads/latest.tar.gz

if you want to use the package from the webpage. If you have downloaded it yourself, use::

    pip install path/to/nowhere.tar.gz

If you're using `distutils <http://docs.python.org/distutils/>`_, type::
    
    tar -xzf path/to/nowhere.tgz    # extract files.
    cd nowhere*                     # change into nowhere directory.
    sudo python setup.py install    # install using distutils (as root).
    #rm -R .                        # remove source. If desired, uncomment this line.
    #cd .. && rmdir nowhere*        # remove working directory. If desired, uncomment this line but be careful.

The project is also available on git, with the package and all supplementary data:

    git clone https://github.com/igsor/nowhere


Make sure all dependencies are installed on your system. As underlying graph library,
[NetworkX]_ has to be installed. For rendering, [Matplotlib]_ has to be available.
You might also want to have [SciPy]_ and [NumPy]_

If you wish to store the library outside of the system's paths, a neat way to
link the library to Python is to use a path configuration file (``.pth``). Place
a file ``<modname>.pth`` in python's default module search path for site packages.
The file must contain nothing else than the actual path to the library. Note that
the module's source must be within a subfolder of the specified path and the subfolder
must have the same name as the module (i.e. ``<modname>``). Normally, ``<modname>``
would be *nowhere*.

To get the site package path, type:

>>> import site
>>> site.getsitepackages()
['/usr/local/lib/python2.7/dist-packages', '/usr/lib/python2.7/dist-packages']

License
-------

This project is released under the terms of the 3-clause BSD License. See the section
:ref:`license` for details.