Skip to content
This repository was archived by the owner on Oct 7, 2019. It is now read-only.

Commit 05ffe5c

Browse files
authored
Update README.md
1 parent 83a34e5 commit 05ffe5c

File tree

1 file changed

+33
-6
lines changed

1 file changed

+33
-6
lines changed

README.md

+33-6
Original file line numberDiff line numberDiff line change
@@ -2,8 +2,35 @@
22

33
A map-based application for estimating the power potential of microhydropower installations.
44

5+
![](https://raw.githubusercontent.com/civicmapper/bard-hydropower/master/docs/bardhydropower_01.jpg)
56

6-
Built as a demonstration project in collaboration with [Bard College](http://www.bard.edu/) and [Current Hydro](http://www.currenthydro.com/).
7+
This was built as a demonstration project for [Bard College](http://www.bard.edu/) and [Current Hydro LLC](http://www.currenthydro.com/). The project was funded by [NYSERDA](https://www.nyserda.ny.gov/).
8+
9+
## What It Does
10+
11+
The Microhydropower Calculator helps estimate the power generation potential of a micro-hydroelectric turbine installation. It guides you through these steps:
12+
13+
### 1. Identify a location for microhydropower, and get information about the terrain
14+
15+
Use the map and available data layers to identify a spot suitable for a potential microhydropower installation. Dam locations (New York State only) and national hydrographic data from US Geological Survey (USGS) are available as map layers. Switch the basemap between several available imagery and topographic styles from Esri and Mapbox to get a better sense of the terrain.
16+
17+
Once you've found a stream or weir, you diagram the location of the installation on the map with the draw tool. The calculator will automatically estimate head (elevation change) and delineate the contributing area using available topographic data.
18+
19+
The underlying elevation data driving the calculations is provided by the USGS through web services hosted by [ESRI](https://www.esri.com/en-us/home). Where available in New York state, head calculations will rely first on high resolution elevation data services hosted by the [NY State GIS Program Office](http://gis.ny.gov/elevation/DEM-web-services.htm), and fall back to coarser USGS elevation data if needed.
20+
21+
### 2. Set calculation parameters
22+
23+
You can input calculation coefficients and other assumptions used in the calculation (sensible defaults are provided).
24+
25+
Optionally, you can also override the head and area estimates derived from map in Step 1.
26+
27+
### 3. See the power potential of a microhydropower installation
28+
29+
View the analysis results, including total kilowatt hours and estimated revenue generation.
30+
31+
## More information
32+
33+
The calculator logic is described in the calculator's About section; you can see that same documentation [here](https://github.com/civicmapper/bard-hydropower/blob/master/app/templates/pages/help_methods.md).
734

835
## Architecture Overview
936

@@ -23,21 +50,21 @@ Front-end business logic is written in javascript with only jQuery. Javascript a
2350

2451
### Configuration (`config.py`)
2552

26-
The application requires a few global configuration variables to be set, mainly to enable access to 3rd-party services.
27-
28-
See `app/config.py` for more information.
29-
30-
_to be completed._
53+
The application requires a few global configuration variables to be set, mainly to enable access to 3rd-party Esri and Mapbox services. Required services include:
3154

3255
#### ArcGIS Application Registration
3356

3457
* Esri Application ID
3558
* Esri Application Secret
3659

60+
Get these by registering an application at https://developers.arcgis.com
61+
3762
#### Mapbox Token
3863

3964
* Token
4065

66+
Get this by generating a token from https://www.mapbox.com
67+
4168
### Development Quickstart
4269

4370
_(for editing HTML and Python only)._

0 commit comments

Comments
 (0)