RESTful API for geospatial and time aggregation across multiple open datasets.

This project is funded by the NSF Computer and Information Science and Engineering (CISE) Directorate through a grant to the Urban Center for Computation and Data (UrbanCCD) at the Computation Institute of the University of Chicago and Argonne National Laboratory. It is being implemented by DataMade and UrbanCCD.

For more details, see the presentation slides from Exploring Open Civic Data Through Time and Space given in June 2014.

• Get the Plenario source:

git clone [email protected]:UrbanCCD-UChicago/plenario.git

Install support libraries for Python:

cd plenario
pip install -r requirements.txt

Create a PostgreSQL database for Plenario. (If you aren't already running PostgreSQL, we recommend installing version 9.3 or later.)

createdb plenario_test

Make sure your local database has the PostGIS extension:

psql plenario_test
plenario_test=# CREATE EXTENSION postgis;

Create your own settings.py file:

cp plenario/settings.py.example plenario/settings.py

You will want to change, at the minimum, the following settings.py fields:

• DATABASE_CONN: edit this field to reflect your PostgreSQL username, server hostname, port, and database name.

• DEFAULT_USER: change the username, email and password on the administrator account you will use on Plenario locally.

If you want your datasets hosted on an S3 bucket, edit the fields AWS_ACCESS_KEY, AWS_SECRET_KEY, and S3_BUCKET. Otherwise, datasets will be downloaded locally to the directory in the DATA_DIR field.

Additionally, create your own celery_settings.py file:

cp plenario/celery_settings.py.example plenario/celery_settings.py

You probably do not need to change any values in celery_settings.py, unless you are running redis remotely (see BROKER_URL).

Before running the server, Redis and Celery also need to be running.

• To start Redis locally (in the background):

redis-server &

• To start Celery locally (in the background):

celery -A plenario.celery_app worker --loglevel=info &

Initialize the plenario database:

python
>>> from plenario import database
>>> database.init_db()

Finally, run the server:

python runserver.py

Once the server is running, navigate to http://localhost:5001/ . From the homepage, click 'Login' to log in with the username and password from settings.py. Once logged in, go to 'Add a dataset' under the 'Admin' menu to add your own datasets.

New datasets are actively being added to the Plenario API. We keep track of them in this Google Doc.

We used the following open source tools:

• PostgreSQL - database version 9.3 or greater
• PostGIS - spatial database for PostgreSQL
• Flask - a microframework for Python web applications
• SQL Alchemy - Python SQL toolkit and Object Relational Mapper
• Green Unicorn - Python WSGI HTTP Server for UNIX
• psycopg2 - PostgreSQL adapter for the Python
• GeoAlchemy 2 - provides extensions to SQLAlchemy for working with spatial databases
• Celery - asynchronous task queue
• Redis - key-value cache

• Charlie Catlett
• Brett Goldstein
• Svetlozar Nestorov
• Jonathan Giuffrida
• Maggie King
• Jiajun Shen

• Derek Eder
• Eric van Zanten
• Forest Gregg
• Michael Castelle

If something is not behaving intuitively, it is a bug, and should be reported. Report it here: https://github.com/UrbanCCD-UChicago/plenario/issues

• Fork the project.
• Make your feature addition or bug fix.
• Send us a pull request. Bonus points for topic branches.

Copyright (c) 2014 University of Chicago and DataMade. Released under the MIT License.