Skip to content

Commit

Permalink
Add screenshot
Browse files Browse the repository at this point in the history
  • Loading branch information
contolini committed Feb 14, 2017
1 parent 46b73ee commit 7b0a266
Show file tree
Hide file tree
Showing 2 changed files with 14 additions and 15 deletions.
29 changes: 14 additions & 15 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,11 +1,9 @@
Mapusaurus
=======
Mapusaurus [![Build Status](https://travis-ci.org/cfpb/mapusaurus.png)](https://travis-ci.org/cfpb/mapusaurus) [![Coverage Status](https://coveralls.io/repos/cfpb/mapusaurus/badge.svg)](https://coveralls.io/r/cfpb/mapusaurus)

[![Build Status](https://travis-ci.org/cfpb/mapusaurus.png)](https://travis-ci.org/cfpb/mapusaurus)
![Mapusaurus screenshot](screenshot.png)

[![Coverage Status](https://coveralls.io/repos/cfpb/mapusaurus/badge.svg)](https://coveralls.io/r/cfpb/mapusaurus)

## Description
## Description

This repository provides data and scripts to set up an API endpoint for serving Home Mortgage Disclosure Act data as well as front-end and back-end application components that feed off this data.
Financial institution data is loaded from raw HMDA files and welded to National Information Center data to allow for more robust analysis in the front-end application.
Expand All @@ -18,9 +16,9 @@ The Mapusaurus back-end is a Python/Django application. Additional requirements
The data you can load is:

* HMDA Transmittal Sheet
* HMDA Reporter Panel
* HMDA Reporter Panel

Both are available from the FFIEC.
Both are available from the FFIEC.

Here are the 2013 files:

Expand All @@ -30,7 +28,7 @@ http://www.ffiec.gov/hmdarawdata/OTHER/2013HMDAInstitutionRecords.zip
Reporter panel:
http://www.ffiec.gov/hmdarawdata/OTHER/2013HMDAReporterPanel.zip

## Requirements
## Requirements

This currently uses:
Django 1.7
Expand Down Expand Up @@ -59,24 +57,25 @@ There's also a fixture that you need to load some information from:
python manage.py loaddata agency
```

This loads static regulator agency data.
This loads static regulator agency data.

Download the two transmittal sheet and reporter panel flat files.
Download the two transmittal sheet and reporter panel flat files.

There are two management commands that will load data, and need to be run
There are two management commands that will load data, and need to be run
in the following order:

```
```
1. python manage.py load_transmittal <path/to/transmittal_sheet>
2. python manage.py load_reporter_panel <path/to/reporter_panel>
```


## GEO

The 'geo' application requires GeoDjango and PostGIS. Follow the instructions
for installing GeoDjango.
for installing GeoDjango.

Here are some separate instructions for running the geo application.
Here are some separate instructions for running the geo application.

```
python manage.py migrate geo
Expand All @@ -95,7 +94,7 @@ ftp://ftp2.census.gov/geo/tiger/TIGER2013/METDIV/
This is how you load the data:

```
# This example only loads census tracts from IL (FIPS code: 17); repeat
# This example only loads census tracts from IL (FIPS code: 17); repeat
# for other states as needed
python manage.py load_geos_from /path/to/tl_2013_17_tract.shp
python manage.py load_geos_from /path/to/tl_2013_us_county.shp
Expand Down
Binary file added screenshot.png
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.

0 comments on commit 7b0a266

Please sign in to comment.