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.) The following command creates the default database, plenario_test. This corresponds with the DB_NAME setting in your plenario/settings.py file and can be modified.

createdb plenario_test

Make sure your local database has the PostGIS extension:

psql plenario_test
plenario_test=# CREATE EXTENSION postgis;

You'll need the ogr2ogr utility; it's part of the gdal package (we use it toimport and export shape datasets)

OSX

brew install gdal --with-postgresql

Ubuntu/Debian

sudo apt-get install gdal-bin

cp plenario/settings.py.example plenario/settings.py
cp plenario/celery_settings.py.example plenario/celery_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 by running python init_db.py.

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.

• 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
• psycopg2 - PostgreSQL adapter for the Python
• GeoAlchemy 2 - provides extensions to SQLAlchemy for working with spatial databases
• GDAL - geospatial data mungeing
• Celery - asynchronous task queue
• Redis - key-value cache
• Gunicorn - WSGI server

Many thanks for the following hosted services that have given us free academic/open source accounts.

• Sentry - exception and task monitoring
• Code Climate - static analysis

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

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

Join our community to hear about platform updates, new features and discuss the potential uses of Plenario. We want to start a conversation with you, the users, about what Plenario can do for you - whether you're a city manager, an app developer, a researcher, or a citizen interested in exploring open data.

Join our Google Group

The plenario/tests folder includes a suite of API tests split across the /points and /shapes directories. To run the tests using with nose, use the command 'nosetests tests' from the /plenario directory

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.