CSC/ECE 517 Fall 2014/final S1455: Difference between revisions

Revision as of 19:38, 22 November 2014

Please read the "README" file provided in expertizza. This wiki page contains design details for the project for Sahana Eden Humanitarian Platform, on their Central African Republic deployment.

Background Information

About Sahana Eden

Sahana Eden is an Open Source Humanitarian Platform, which can be used to provide solutions for Disaster Management, Development, and Environmental Management sectors. It is supported by the Sahana Software Foundation, Used in many Deployments, such as Ebola, Kashmir Floods, Hurricane Sandy, just to name a few. It is highly configurable so that it can be used in a wide variety of different contexts and is easy to modify to build custom solutions. Different levels of support are available from both the voluntary Sahana Eden community and professional companies. Sahana focuses on Community and Professional Support.

Getting to know the domain

Their domain page elaborately describes various major management projects and deployments that are done in the past or are ongoing. Spending some time to understand goals and purposes of Sahana before starting with actual development might help making the code better and more sensible from Sahana's perspective.

Installation & tutorials

Anyone who wishes to contribute their development skill to Sahana, can do so with the help of an elaborate guide they have provided, that covers everything from installation to tutorials on Python. Once the installations are complete, you can simply identify a task you are interested in, and start working on it. You may also want to sign their Contributor's License Agreement before making any pull request.

Below is a high level overview to begin contributing to Sahana-

The code is in the folder: web2py/applications/eden

Inside that folder are folders for Models (define the data structure), Controllers (provide URLs to enable access to the data) & Views (HTML templates).

Each module within Sahana Eden will normally consist of one of each of these files:

   Model: modules/s3db/modulename.py
   Controller: controllers/modulename.py
   View: views/modulename/index.html

In order to know which file to edit in order to change a particular function, you need to look at the URL. The Web2Py web framework maps URLs as follows:

   http://host/application/controller/function

So, if you want to edit the Home page with the URL:

   http://host/eden/default/index

This implies that you should look at the file eden/controllers/default.py and the index function within it which can be found by searching for the function title "def index():"

Tip: Sahana Eden makes heavy use of integrated resource controllers so the typical mapping is:

   http://host/eden/module/resource

The resource refers to a table with the name module_resource in the file modules/s3db/<module>.py

Introduction to project

Overview

In the Central African Republic page, some data needs new models, and some models need tweaking. The purpose of this project is to identify any such requirement and make necessary changes. The general steps to follow in Sahana development are mentioned below-

1. Add/modify the core models in modules/s3db

2. Add REST controllers for new models

3. Check basic operations using automatic CRUD interface- tweak list_fields to the most-relevant fields perhaps

4. Add menu entries (modules/s3menus.py)

5. Develop XSLT & CSV templates (static/formats/s3csv) to bulk import the data

6. Convert the data to these CSV templates- use ogr2ogr for this

7. Add layers to the map (private/templates/<TEMPLATE>/gis_layer_feature.csv. Look at default for now) including Markers and tooltips (popup_format)

8. Provide some report_options to make a meaningful report

Scope

Four modules related to this deployment are-

1. Health - modules/s3db/hms.py

2. Transport - modules/s3db/transport.py

3. Water - modules/s3db/water.py

4. School - There is no separate module for education.

Reference Material

Hospital Model

Border Control Points, Roads, Routes, Airports

Water Bodies, Water Points, Rivers

Education

System Overview

Sahana Eden Framework:

The Sahana Eden Software Platform has been built around a Rapid Application Development (RAD) Framework. This provides a high level of automation to ensure that new solutions can be quickly and effectively developed. Once a database table is defined, the Sahana Eden Framework automatically generates HTML pages to handle CRUD (Create, Read, Update, Delete) as well as Search, Map and Pivot Reports. Web Services are available to import and export in XML, CSV, JSON and EXtensible Stylesheet Language (XSL) transforms are supported to produce other data standards.

The Sahana Eden Framework has flexible authorization policies which can be configured to grant permissions for different modules, tables as well as the ability to have multiple Organizations control their own data on a single Sahana Eden installation.

Sahana Eden can be downloaded and run locally from a flash drive. Synchronization functionality allows data to be entered then keep up to date between different installations, including online servers and local flash drive installations. The Sahana Eden Framework also includes a scheduler for running tasks at a specific time, in regular intervals or as asynchronous tasks which are triggered by users.

Sahana Eden is mainly implemented using Python, web2py, CSS and foundation. When you open the code in Eclipse, you can see that web2py is very much like Ruby on Rails. Analyze the screenshots below-

Our focus is on Controllers, Models, Modules and views. For every action on various pages on Sahana Humanitarian website, there are set of controllers defined. As mentioned above, we want to focus on 4 models- health, transport, water and school.

Sahana

Unicef Key	Unicef value (number)	OSM tag
all objects		`<a href="/wiki/Key:amenity" title="Key:amenity">amenity</a>=<a href="/wiki/Tag:amenity%3Dhospital" title="Tag:amenity=hospital">hospital</a>`
all objects		`<a href="/wiki/Key:source" title="Key:source">source</a>=<a href="/w/index.php?title=Tag:source%3DUNICEF&action=edit&redlink=1" class="new" title="Tag:source=UNICEF (page does not exist)">UNICEF</a>`
ID		not tagged because not relevant
WPT		not tagged because not relevant
CODE		not tagged because not relevant
FOSA_CODE		not tagged because not relevant
LAT_DD		not tagged because not relevant
LONG_DD		not tagged because not relevant
PAYS		not tagged because not relevant
PREF, SOUS_PREF, COMM, VILLE_VILL, QUARTIER		`<a href="/w/index.php?title=Key:addr%CB%90full&action=edit&redlink=1" class="new" title="Key:addrːfull (page does not exist)">addrːfull</a>=*`
VILLE_VILL		`<a href="/wiki/Key:addr:city" title="Key:addr:city" class="mw-redirect">addr:city</a>=*`
POP_VILLE		not tagged because not relevant
STATUT_FOS	Public (306)	`<a href="/wiki/Key:operator:type" title="Key:operator:type">operator:type</a>=<a href="/w/index.php?title=Tag:operator:type%3Dgovernment&action=edit&redlink=1" class="new" title="Tag:operator:type=government (page does not exist)">government</a>`
STATUT_FOS	Prive (37)	`<a href="/wiki/Key:operator:type" title="Key:operator:type">operator:type</a>=<a href="/w/index.php?title=Tag:operator:type%3Dprivate&action=edit&redlink=1" class="new" title="Tag:operator:type=private (page does not exist)">private</a>`
TYPE_FOSA	Poste de sante (204)	`<a href="/w/index.php?title=Key:health_facility:type&action=edit&redlink=1" class="new" title="Key:health facility:type (page does not exist)">health_facility:type</a>=<a href="/w/index.php?title=Tag:health_facility:type%3Ddispensary&action=edit&redlink=1" class="new" title="Tag:health facility:type=dispensary (page does not exist)">dispensary</a>`
TYPE_FOSA	Centre de sante (with beds) (118)	`<a href="/w/index.php?title=Key:health_facility:type&action=edit&redlink=1" class="new" title="Key:health facility:type (page does not exist)">health_facility:type</a>=<a href="/w/index.php?title=Tag:health_facility:type%3Dhealth_center&action=edit&redlink=1" class="new" title="Tag:health facility:type=health center (page does not exist)">health_center</a>`
TYPE_FOSA	Hopital prefectoral (7)	`<a href="/w/index.php?title=Key:health_facility:type&action=edit&redlink=1" class="new" title="Key:health facility:type (page does not exist)">health_facility:type</a>=<a href="/w/index.php?title=Tag:health_facility:type%3Dprefectoral_hospital&action=edit&redlink=1" class="new" title="Tag:health facility:type=prefectoral hospital (page does not exist)">prefectoral_hospital</a>`
TYPE_FOSA	Hopital regional (3)	`<a href="/w/index.php?title=Key:health_facility:type&action=edit&redlink=1" class="new" title="Key:health facility:type (page does not exist)">health_facility:type</a>=<a href="/w/index.php?title=Tag:health_facility:type%3Dregional_hospital&action=edit&redlink=1" class="new" title="Tag:health facility:type=regional hospital (page does not exist)">regional_hospital</a>`
TYPE_FOSA	Clinique privee (1)	`<a href="/w/index.php?title=Key:health_facility:type&action=edit&redlink=1" class="new" title="Key:health facility:type (page does not exist)">health_facility:type</a>=<a href="/w/index.php?title=Tag:health_facility:type%3Dprivate_hospital&action=edit&redlink=1" class="new" title="Tag:health facility:type=private hospital (page does not exist)">private_hospital</a>`
TYPE_FOSA	No attribut (1)	not to upload
NOM_FOSA		`<a href="/wiki/Key:name" title="Key:name">name</a>=*`
NB_LITS	numbers 0-179	`<a href="/w/index.php?title=Key:capacity:beds&action=edit&redlink=1" class="new" title="Key:capacity:beds (page does not exist)">capacity:beds</a>=*`
NB_PERS_SO		not tagged because unknown meaning
NB_PATIENT		not tagged because not relevant
COMITE_WAS	Oui/Non	not tagged because not relevant
NB_PERS_WA		not tagged because not relevant
LTA		not tagged because unknown meaning
VIP		not tagged because unknown meaning
VIP_PLEIN		not tagged because unknown meaning
LATRINES_S		not tagged because not relevant
LAVE_MAINS	Oui/Non	not tagged because not relevant
INCINERATE		not tagged because not relevant
BAC_A_ORDU	Oui/Non	not tagged because not relevant
TOTAL_LATR	numbers 0-23	`<a href="/w/index.php?title=Key:toilets:number&action=edit&redlink=1" class="new" title="Key:toilets:number (page does not exist)">toilets:number</a>=*`

System Architecture

The basic Sahana Eden architecture is as follows:

Web Server	Apache	Other web servers can also be used, such as Cherokee.
Application	Sahana Eden
Web Application Framework	Web2Py
Programming Language	Python & Java Script
Database	MySQL, PostgreSQL, or SQLite	MySQL, PostgreSQL, and SQLite are supported. Other databases should be usable without major additional work since Web2Py supplies many connectors.
Operating System	Linux (Debian recommended)	Windows and Mac OS X are possible, but only recommended for single-user environments.

Requirement Analysis

The requirements state that some of the data needs new models. Also, the school database states that there is no module for education. Even on the education website of Central African Republic, it says that the data is incomplete. Addition of new module, say edu.py in s3db module, will solve this problem.

For the purpose of this project, we will need to follow these steps-

1. Installation and setup- Follow the installation guidlines provided by Sahana to build the system on individual machines. Then, do the setup for Git repository, i.e. forking Sahana eden repo and adding the original as remote branch.

2. Identify properties for "edu.py" and define the basic data model in the models/ folder.

3. Add corresponding controller which provides access to this resource. Create another new file, this time in the controllers/ folder.

4. Define Field Types- By default fields are created with type string, however we may wish to use other data types. All fields have both client-side widgets & server-side validation automatically added based on their data type.

5. Customize & Internationalize Field labels- Field labels are automatically generated from the field names, however we are able to customize these by adding a 'label' attribute.

6. Add Links to other Resources.

7. Override default CRUD Strings.

8. Update the Menus- There are two levels of menu within the system: The top-level 'Modules Menu' is visible in all modules. Underneath that, each module has its own menu for for module-specific navigation.

9. Test the changes.

Design Principles

For our project, the best design principle applicable is "Open Close Principle". Since we are introducing a new module, there will definitely be extensions to it, but very few modifications.

The common features/functions will be encapsulated to ensure that the code is "DRY".

Proposed Test Cases

For end-user performance gains, Sahana Eden minimizes and compresses the CSS and JavaScript. While this approach works well for optimized end-user performance, to debug the CSS and JavaScript we shall enable debug mode in models/000_config.py in our Sahana Eden server with the following setting:

 settings.base.debug = True

Once any changes to the CSS and JavaScript are working, then we can minimizes and compresses the CSS and JavaScript using:

 static/scripts/tools/build.sahana.py

Although this uses a web service, you get better results by downloading a local version of the Closure Compiler (a tool for making JavaScript download and run faster) to static/scripts/tools. It is also possible to quickly view a single page in debug mode by adding the ?debug=1 variable to the end of a URL.