Skip to content

HTTPS clone URL

Subversion checkout URL

You can clone with
or
.
Download ZIP
Newer
Older
100644 91 lines (61 sloc) 2.876 kB
35c0dd7 Updated README with useful info.
cgroskopf authored
1 census.ire.org
2 ==============
3
4 A nationwide census browser for 2000 and 2010 census data.
5
6 Dependencies
7 ============
8
9 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/):
10
11 Other required software:
12
13 * mongodb
14 * wget
15 * mdbtools.
16
17 On a Mac you can get these with Brew::
18
19 brew install mongodb
20 brew install wget
21 brew install mdbtools
22
23 Bootstrapping the webapp
24 ========================
25
26 To get the web application running::
27
28 cd censusweb
29 mkvirtualenv --no-site-packages censusweb
30 pip install -r requirements.txt
b706118 Added credits and license.
cgroskopf authored
31 python manage.py runserver
35c0dd7 Updated README with useful info.
cgroskopf authored
32
33 Configuring the webapp
34 ======================
35
b706118 Added credits and license.
cgroskopf authored
36 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 your own data open censusweb/config/settings.py and modify the following line::
35c0dd7 Updated README with useful info.
cgroskopf authored
37
38 API_URL = 'http://s3.amazonaws.com/census-test'
39
40 See the next section to learn how to deploy data to your custom S3 bucket.
41
42 Loading data
43 ============
44
45 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::
46
47 CENSUS_USER=cgroskopf@tribune.com
48 CENSUS_PASS=NotMyRealPassword
49
50 You will also need to have defined your Amazon Web Services credentials so that you can upload the rendered data files to S3::
51
52 export AWS_ACCESS_KEY_ID="foo"
53 export AWS_SECRET_ACCESS_KEY="bar"
54
55 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::
56
57 S3_BUCKETS = {
58 'staging': 'census-test',
59 'production': 'censusdata.ire.org',
60 }
61
62 To load SF1 data for Hawaii make sure you have Mongo running and then execute the following commands::
63
64 cd dataprocessing
65 ./batch_sf.sh Hawaii staging
66
b706118 Added credits and license.
cgroskopf authored
67 Credits
68 =======
69
2e33799 Copy editing.
cgroskopf authored
70 This application was a project of `Investigative Reporters and Editors <http://www.ire.org/>`_ / `National Institute for Computer-Assisted Reporting <http://data.nicar.org/>`_. Funding was generously provided by `The Reynolds Journalism Institute <http://www.rjionline.org/>`_.
b706118 Added credits and license.
cgroskopf authored
71
6a080b9 Copy editing.
cgroskopf authored
72 The following journalists and nerds contributed to this project:
b706118 Added credits and license.
cgroskopf authored
73
74 * Jeremy Ashkenas (DocumentCloud)
75 * Brian Boyer (Chicago Tribune)
76 * Joe Germuska (Chicago Tribune)
6a080b9 Copy editing.
cgroskopf authored
77 * Christopher Groskopf (Chicago Tribune)
b706118 Added credits and license.
cgroskopf authored
78 * Mark Horvit (IRE)
79 * Ryan Mark (Chicago Tribune)
80 * Curt Merrill (CNN)
81 * Paul Overberg (USA Today)
82 * Ted Peterson (IRE)
83 * Aron Pilhofer (New York Times)
84 * Mike Tigas (Spokesman-Review)
85 * Matt Waite (University of Nebraska)
86
87 License
88 =======
89
90 This software is licensed under the permissive MIT license. See COPYING for details.
Something went wrong with that request. Please try again.