https://github.com/abrie/zctaimpacts

Show USEEIO environmental impact footprints for State, County, and ZCTA regions.
https://github.com/abrie/zctaimpacts

atlanta epa georgia useeio useeior

Last synced: about 1 month ago
JSON representation

Show USEEIO environmental impact footprints for State, County, and ZCTA regions.

• Host: GitHub
• URL: https://github.com/abrie/zctaimpacts
• Owner: abrie
• Created: 2021-09-13T20:11:30.000Z (over 3 years ago)
• Default Branch: main
• Last Pushed: 2021-12-14T01:40:04.000Z (about 3 years ago)
• Last Synced: 2024-01-28T21:40:56.287Z (11 months ago)
• Topics: atlanta, epa, georgia, useeio, useeior
• Language: TypeScript
• Homepage: https://zctaimpacts.abrie.dev
• Size: 61.9 MB
• Stars: 0
• Watchers: 1
• Forks: 1
• Open Issues: 1
• Metadata Files:
  • Readme: README.md

Awesome Lists containing this project

README

        
# ZCTA Impacts

A project for the [2021 Sustainable Communities Web Challenge](https://model.earth/community/challenge/).

Generates Environmental Footprint ["Nutrition Labels"](https://model.earth/io/template/) for communities in the USA.

## Live Site

The CI process publishes new builds to: https://zctaimpacts.abrie.dev

You are able to visit the live site for a UI, or query it using the API:

`curl -X POST -H "Content-Type: application/json" -d '{"statefp":17,"countyfp":31}' http://localhost:5000/query/county/impacts`

## Self Hosting

There are two options: Docker, or from source. Both options require API keys and a local copy of the database.

### First, The Database

The finished database is about 220 megabytes, and must be built from scratch. A utility script is provided:

1. `cd backend/utils`

2. Execute `./build.sh`

3. Copy the resulting file `out/db.spatialite` file to `backend/instance`

### Next, API Keys

The app queries the Census.gov API for County Business Patterns information. This app needs an API key do that.

1. [Get one here](https://api.census.gov/data/key_signup.html).

2. Copy `backend/secrets.json` to `backend/instance` and your your API key to it.

### Option 1: Use Docker

1. `docker run -v{/full/path/to/instance/folder}:/backend/instance abriedev/zctaimpacts` will serve on port 80.

### Option 2: Run from source

1. Install backend dependencies: `cd backend && python -m pip install --upgrade pip`

2. Start the backend: `cd backend && make serve`

3. Install frontend dependencies: `yarn`

4. Start the frontend: `cd frontend && yarn start`

5. Access the site through `http://localhost:3000`