Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

README updates #280

Merged
merged 10 commits into from
Jan 30, 2015
Merged

README updates #280

Changes from all commits
Commits
Show all changes
10 commits
Select commit Hold shift + click to select a range
19599bc
notes to readme changes
wpears Jan 28, 2015
092869b
Updating README with travis badge and some software version updates
imuchnik Jan 28, 2015
b274d5f
fixing the ci badge
imuchnik Jan 28, 2015
96eabb1
Merge pull request #5 from imuchnik/master
wpears Jan 28, 2015
de2ac31
adding coverage badge
imuchnik Jan 28, 2015
82aa624
Merge pull request #6 from imuchnik/master
wpears Jan 28, 2015
bf18568
Updated readme description
wpears Jan 28, 2015
4740e5b
Updated notes with elasticsearch info
wpears Jan 28, 2015
f56cf87
reformat notes, api.md reference
wpears Jan 28, 2015
6899c9e
Removed notes.txt, slight update to readme
wpears Jan 28, 2015
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
26 changes: 16 additions & 10 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,12 +1,16 @@
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)

## Description

Mapusaurus loads institution data from HMDA, and maps HMDA
reporter ids to National Information Center ids for easy identification.
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.

Mapusaurus is a Python/Django application. Additional requirements are defined below.
The Mapusaurus back-end is a Python/Django application. Additional requirements are defined below.


## Data
Expand All @@ -28,23 +32,25 @@ http://www.ffiec.gov/hmdarawdata/OTHER/2013HMDAReporterPanel.zip

## Requirements

This currently uses:
This currently uses:
Django 1.7
Python 2.7.8
Python 2.7.x

You will also need:
PostgreSQL 9.3
PostGIS 2.1.x
ElasticSearch

PostgreSQL 9.2
PostGIS 2.1.3
There's also a requirements.txt file in the repository root directory that can be installed with pip.

There's also a requirements.txt file in the repository root directory.

## Loading the data

This uses South.

To create the tables, you need to run:

```
python manage.py migrate respondants
python manage.py migrate respondents
```

There's also a fixture that you need to load some information from:
Expand Down