Skip to content

HTTPS clone URL

Subversion checkout URL

You can clone with HTTPS or Subversion.

Download ZIP
Browse files

Updated README with useful info.

  • Loading branch information...
commit 35c0dd7e3d48e3b74e6d341d2c67dc6de790346e 1 parent 40b642b
cgroskopf authored
Showing with 67 additions and 24 deletions.
  1. +0 −24 README
  2. +67 −0 README.rst
24 README
View
@@ -1,24 +0,0 @@
-To bootstrap the web app:
-
-(Assumes you've got Python 2.6, the PostGIS stack, virtualenv and virtualenvwrapper. Installation instructions: http://blog.apps.chicagotribune.com/2010/02/17/quick-install-pythonpostgis-geo-stack-on-snow-leopard/):
-(Other non-pippable installs:
-On a mac, you can use brew:
- brew install mongodb
- brew install wget
- brew install mdbtools
-)
-
-cd censusweb
-mkvirtualenv --no-site-packages censusweb
-pip install -r requirements.txt
-cd ../dataprocessing
-./batch_test.sh
-cd ../censusweb
-./manage.py runserver
-
-NOTE FOR POSTERITY:
-
-Embargo username/password must be defined as environment variables
-
-CENSUS_USER=cgroskopf@tribune.com
-CENSUS_PASS=NotMyRealPassword
67 README.rst
View
@@ -0,0 +1,67 @@
+census.ire.org
+==============
+
+A nationwide census browser for 2000 and 2010 census data.
+
+Dependencies
+============
+
+You will need Python 2.7, the PostGIS stack, virtualenv and virtualenvwrapper. Mac Installation instructions at: http://blog.apps.chicagotribune.com/2010/02/17/quick-install-pythonpostgis-geo-stack-on-snow-leopard/):
+
+Other required software:
+
+* mongodb
+* wget
+* mdbtools.
+
+On a Mac you can get these with Brew::
+
+ brew install mongodb
+ brew install wget
+ brew install mdbtools
+
+Bootstrapping the webapp
+========================
+
+To get the web application running::
+
+ cd censusweb
+ mkvirtualenv --no-site-packages censusweb
+ pip install -r requirements.txt
+ cd ../censusweb
+ ./manage.py runserver
+
+Configuring the webapp
+======================
+
+By default the webapp is going to use the data published to the IRE test site, which may not be accessible to you. To use you're own data open censusweb/config/settings.py and modify the following line::
+
+ API_URL = 'http://s3.amazonaws.com/census-test'
+
+See the next section to learn how to deploy data to your custom S3 bucket.
+
+Loading data
+============
+
+Once you've setup the webapp you will have the requirements needed to load data. If you want to load embargoed data you will need to define environment variables for your username and password::
+
+ CENSUS_USER=cgroskopf@tribune.com
+ CENSUS_PASS=NotMyRealPassword
+
+You will also need to have defined your Amazon Web Services credentials so that you can upload the rendered data files to S3::
+
+ export AWS_ACCESS_KEY_ID="foo"
+ export AWS_SECRET_ACCESS_KEY="bar"
+
+You will also need to modify the load configuration to point at the same S3 bucket you configured for the webapp. Open dataprocessing/config.py and modify the following lines::
+
+ S3_BUCKETS = {
+ 'staging': 'census-test',
+ 'production': 'censusdata.ire.org',
+ }
+
+To load SF1 data for Hawaii make sure you have Mongo running and then execute the following commands::
+
+ cd dataprocessing
+ ./batch_sf.sh Hawaii staging
+
Please sign in to comment.
Something went wrong with that request. Please try again.