InaSAFE is written in python and runs as a plugin in |QGIS|.

These instructions are for setting up a development environment on a Debian based linux system such as Ubuntu or Mint.

There are actually three ways of setting up a development environment for InaSAFE:

1. Goto the area where you do development, e.g cd ~/sandbox
2. wget bit.ly/inasafe-install
3. source ./inasafe-install

To verify that the installation works you can run the test suite from the command line:

cd inasafe-dev
make test

This will run all the regression tests and also highlight any code issues. Note that first time the tests are run they will pull 250MB of test data from our git repository. See further notes on running tests below.

To run the plugin start QGIS and enable it from the :menuselection:`Plugins --> Manage Plugins` menu.

If this doesn't work see section towards the end of this document about dependencies and try to do a manual install.

There is a much easier and more advanced way to control the setup of the environment. It is done with Fabric.

Obviously you need to have fabric installed. Fabric itself is Python based and you can install it with pip. If you don't have pip installed you should install it too. We assume you have sudo rights on your own machine.:

mkdir -p ~/dev/python
cd ~/dev/python
sudo apt-get install python-pip openssh-server
pip install fabgis
wget -O fabfile.py https://raw2.github.com/AIFDR/inasafe/master/fabfile.py
fab -H localhost setup_inasafe

The Graphical User Interface components are built using PyQt4 and the QGIS plugin API (useful resources: the QGIS Python Cookbook and the QGIS C++ API documentation). As such it is helpful if you are familiar with these technologies (python, Qt4, PyQt4, QGIS). In addition, the following are needed on your machine in order to work effectively with the code base:

• git
• rsync
• pep8
• nosetests (with coverage plugin)
• python-numpy (for numerical computations)
• python-gdal (python bindings to underlying gis functionality)
• python-sphinx (compilation of documents)
• cloud-sptheme (sphinx theme)
• pyqt4-dev-tools (compiling ui and resources)
• qt4-doc (qt4 API documentation)
• pyflakes (test for bad coding style like unused imports / vars)
• python-nosexcover and python-coverage (code coverage reporting)

On an ubuntu system you can install these requirements using apt:

sudo apt-get install git rsync pep8 python-nose python-coverage \
python-gdal python-numpy python-sphinx pyqt4-dev-tools pyflakes \
python-nosexcover

In some cases these dependencies may already be on your system via installation process you followed for QGIS.

To develop on the plugin, you first need to copy it to your local system. If you are a developer, the simplest way to do that is go to :file:`~/.qgis2/python/plugins` and clone InaSAFE from our GitHub repository page like this:

git clone git://github.com/AIFDR/inasafe.git inasafe-dev        (for read only)
git clone git@github.com:AIFDR/inasafe.git inasafe-dev   (to commit changes)

For running unit tests that need QGIS, you may need to adjust PYTHONPATH and QGIS_PREFIX_PATH if QGIS is running in a non standard location. For example with QGIS built from source into /usr/local (and python bindings global install option disabled), you could run these commands (or add them to your ~/ .bashrc):

export QGIS_PREFIX_PATH=/usr/local
export PYTHONPATH=$PYTHONPATH:/usr/local/share/qgis/python/

Lastly, you should add the InaSAFE plugin folder to your PYTHONPATH so that package and module paths can be resolved correctly. E.g:

export PYTHONPATH=$PYTHONPATH:${HOME}/.qgis2/python/plugins/inasafe-dev

Once again you could add this to your .bashrc or set it in Eclipse for convenience if needed.

You can run all tests (which includes code coverage reports and other diagnostics) by doing this within the InaSAFE plugin folder:

source run-env-linux.sh     (optional, depends on your setup)
make test

You can also run individual tests using nose. For example to run the safe_qgis tools tests you would do:

nosetests -v safe_qgis.tools.test

If you wish to run tests under xvfb (a virtual framebuffer), you can do:

sudo apt-get install xvfb

To run tests under xvfb you can now do:

xvfb-run --server-args="-screen 0, 1024x768x24" make guitest

Optionally you can enable nose achievments which is a motivational tool that gives you little achievement awards based on your test results:

sudo pip install git+git://github.com/exogen/nose-achievements.git

Now create this file in the root of your InaSAFE git checkout :file:`setup.cfg`:

[nosetests]
with-achievements=1

When you run tests occasionally achievements will be displayed to you at the end of the test run. See the achievements home page at http://exogen.github.com/nose-achievements/.

If you wish to use an IDE for development, please refer to this article for detailed information on how to get the basic Eclipse with PyDev setup.

The procedure for doing this is to do: :menuselection:`File --> New --> Project...` and then from the resulting dialog do :menuselection:`PyDev --> PyDev Project`.

In the resulting project dialog, set the following details:

• :guilabel:`Project name:` : inasafe
• :guilabel:`Use default` : uncheck
• :guilabel:`(linux) Directory` : /home//.qgis2/python/plugins/inasafe/
• :guilabel:`(windows) Directory` : /home//.qgis2/python/plugins/inasafe/
• :guilabel:`Choose project type` : Python
• :guilabel:`Grammar Version` : 2.7
• :guilabel:`Add project directory to PYTHONPATH?` : check

At this point you should should click the link entitled 'Please configure an interpreter in related preferences before continuing.' And on the resulting dialog do:

• :guilabel:`Python Interpreters: New...` : click this button

In the dialog that appears do:

• :guilabel:`Interpreter Name` : System Python 2.7
• :guilabel:`Interpreter Executable` : /usr/bin/python
• :guilabel:`OK Button` : click this button

Another dialog will appear. Tick the first entry in the list that points to your:

~/.eclipse/org.eclipse.platform_3.7.0_155965261/plugins/org.python.pydev_2.3.0.2011121518/

(or simply click the 'Select All' button)

• :guilabel:`OK Button` : click this button

You will be returned to the Python Interpreters list and should see an entry for System Python 2.7 listed there. Now do in the Libraries tab:

• :guilabel:`Finish` : click this button

For remote debugging, you should add pydevd to your PYTHONPATH before starting QGIS for example (you will need to adjust these paths to match your system):

export PYTHONPATH=$PYTHONPATH:/home/timlinux/.eclipse/org.eclipse.platform_3.7.0_155965261/plugins/org.python.pydev.debug_2.3.0.2011121518/pysrc/

You will need to ensure that the PYTHONPATH containing your pydev package folder is set before you launch QGIS - for example by adding the above line to your ~/.bashrc or by making a small batch file containing the above export and then sourcing the file before launching QGIS e.g.:

source riab_paths.sh
/usr/local/bin/qgis

Python has very good integrated support for unit testing. The first thing you should do after setting up the IDE project is to run the tests. You can run tests in the following ways:

• For the entire InaSAFE package
• For individual sub packages (e.g. engine, gui, storage, impact_functions)
• for an individual test module within a package
• for an class within a test module
• for an individual method within a test class

You can view these individual entities by browsing and expanding nodes in the project panel in the left of the IDE.