AIFDR / riab

Risk in a Box - main project
Other
17 stars 6 forks source link

====================== RISIKO - RISK IN A BOX

This is the project: "Risiko - Risk in a Box". The latest source code is available in https://github.com/AIFDR/riab/tree/master/impact which contains modules for risk calculations, gis functionality and plugin management.

For more information about Risk In a Box please look at our documentation on http://riab.readthedocs.org

============ INSTALLATION

These are the instructions for installation of Risiko in development mode (for changing the software) and production mode (for deploying on a server).


System Requirements


Development installation

This is for those who either want to try out the software and/or modify it. For installing Risiko as a public web server please see instructions for production installation.

To install a RISIKO development environment, start a terminal window, cd to your favorite development area and run the following::

wget http://bit.ly/riab-install bash riab-install

This will create a working development installation and provide guidance on how to run the test suite, setup the server and try it. Note if you want to move the installation you need to run risiko-uninstall and install it again in the new location. It is OK to run riab-install again on an existing installation e.g. to update it.

To run the test suite, you'll need the commands::

risiko-activate risiko-test

To upload the bundled demo data, you'll need to do the following::

risiko-activate risiko-clean risiko-start risiko-upload risiko_demo_data

when this is finished point the browser to 127.0.0.1:8000, select layers and try the risk calculator.

Note: If you wish to commit changes back to the repository, you must

  1. Get an account on github.com
  2. Get commit access to https://github.com/AIFDR/riab
  3. Setup and register your ssh keys with your account: https://github.com/account/ssh

Production installation (Obsolete!)

This is for installing Risiko as a public web server.

It is assumed that a development system is already running (installed as per instructions above) and that the production system is a separate server that can be accessed via ssh (ssh username@remote.server).

To deploy RISIKO in production mode from your development system to the remote server run the following::

risiko-activate cd $RIAB_HOME/riab/extras fab risiko -H username@remote.server

If something goes wrong, you can check the logs with the command::

fab log -H username@remote.server

You can update an existing production system to the latest revision with the command::

fab pull -H username@remote.server

The production deployment procedure is scripted in the file fabfile.py and the fabric framework is documented at http://docs.fabfile.org

=========== LIMITATIONS

Risiko is a very new project. The current code development started in earnest in March 2011 and there is still much to be done. However, we work on the philosophy that stakeholders should have access to the development and source code from the very beginning and invite comments, suggestions and contributions.

As such, Risiko currently has some major limitations, including