Merge pull request #23 from civicmapper/integrate-local-dem

Integrate local dem

Author: gassc

Pipfile

@@ -7,39 +7,11 @@ name = "pypi"
 
 [packages]
 
-argh = "==0.26.2"
-bcrypt = "==3.1.1"
-cffi = "==1.9.1"
-coverage = "==3.7.1"
-cssutils = "==1.0.2"
-ecdsa = "==0.13"
-Fabric = "==1.10.1"
-Flask = "==0.10.1"
-Flask-Bcrypt = "==0.6.2"
-Flask-Login = "==0.4.0"
-Flask-SQLAlchemy = "==1.0"
-Flask-WTF = "==0.11"
-gunicorn = "==19.3.0"
-itsdangerous = "==0.23"
-"Jinja2" = "==2.7.2"
-jsmin = "==2.2.2"
-MarkupSafe = "==0.18"
-nose = "==1.3.4"
-paramiko = "==1.12.2"
-pathtools = "==0.1.2"
-pycparser = "==2.17"
-pycrypto = "==2.6.1"
-pyparsing = "==2.1.10"
-python-bcrypt = "==0.3.1"
-python-dateutil = "==2.6.0"
-PyYAML = "==3.12"
-requests = "==2.13.0"
-SQLAlchemy = "==0.9.9"
-watchdog = "==0.8.3"
-webassets = "==0.12.1"
-Werkzeug = "==0.10.1"
-WTForms = "==1.0.5"
-Flask-JSGlue = "*"
+flask = "*"
+flask-jsglue = "*"
+flask-markdown = "*"
+watchdog = "*"
+requests = "*"
 
 
 [dev-packages]

Pipfile.lock

@@ -7,15 +7,19 @@
 # dependencies
 from flask import Flask, render_template, request, session, redirect, url_for, flash, send_from_directory, jsonify,  make_response
 from flask_jsglue import JSGlue
+from flaskext.markdown import Markdown
 import requests
-import pdb
+# import pdb
 
 #----------------------------------------------------------------------------
 # APPLICATION SETUP
 
 app = Flask(__name__)
 app.config.from_pyfile('config.py')
+# add JSGlue plugin
 jsglue = JSGlue(app)
+# add Markdown plugin
+Markdown(app)
 
 #----------------------------------------------------------------------------
 # HELPERS

app/__init__.py

@@ -1,5 +1,5 @@
 <!-- Fixed navbar -->
-<div class="navbar navbar-inverse navbar-fixed-top">
+<div class="navbar navbar-default navbar-fixed-top">
     <div class="container-fluid">
         <div class="navbar-header">
             <button type="button" class="navbar-toggle" data-toggle="collapse" data-target=".navbar-collapse">
@@ -13,16 +13,11 @@
         </div>
         <div class="collapse navbar-collapse">
             <ul class="nav navbar-nav navbar-right">
-                <li id="results-nav-button-item">
-                    <div><button id="swipe-btn" class="btn btn-primary btn-block sidebar-toggle" type="submit"><i class="fa fa-arrows-h"></i></button></div>
+                <li>
+                    <button id="about-btn" class="btn btn-default navbar-btn" type="submit"><i class="fa fa-info-circle"></i></button>
                 </li>
-                <li class="dropdown">
-                    <!--<li id="parameters-nav-button-item"><div><button id="nav-params-btn" class="btn btn-primary btn-block params-btn" type="submit">Parameters</button></div></li>
-              <li id="analyze-nav-button-item"><div><button id="nav-analyze-btn" class="btn btn-primary btn-block analyze-btn" type="submit">Calculate</button></div></li>
-              <li id="results-nav-button-item"><div><button id="nav-results-btn" class="btn btn-primary btn-block results-btn" type="submit">Results</button></div></li>-->
-                    <li id="results-nav-button-item">
-                        <div><button id="about-btn" class="btn btn-primary btn-block" type="submit"><i class="fa fa-info-circle"></i></button></div>
-                    </li>
+                <li>
+                    <button id="swipe-btn" class="btn btn-default navbar-btn sidebar-toggle" type="submit"><i class="fa fa-arrows-h"></i></button>
                 </li>
             </ul>
         </div>

app/static/assets/currenthydro-40px.png

@@ -0,0 +1,39 @@
+<div class="modal" id="aboutModal" tabindex="-1" role="dialog">
+    <div class="modal-dialog modal-lg">
+        <div class="modal-content">
+            <div class="modal-header">
+                <button class="close" type="button" data-dismiss="modal" aria-hidden="true">&times;</button>
+                <h3 class="modal-title">Microhydropower Calculator</h3>
+                <h3><small>A project by Bard College and Current Hydro</small></h3>
+            </div>
+            <div class="modal-body">
+                <ul class="nav nav-tabs nav-justified" id="aboutTabs">
+                    <li class="active">
+                        <a href="#about" data-toggle="tab">
+                            <span class="glyphicon glyphicon-info-sign" aria-hidden="true"></span> About</a>
+                    </li>
+                    <li>
+                        <a href="#methods" data-toggle="tab">
+                            <span class="glyphicon glyphicon-book" aria-hidden="true"></span> How It Works</a>
+                    </li>
+
+                </ul>
+                <div class="tab-content" id="aboutTabsContent">
+                    <div id="about" class="tab-pane active in">
+                        <p>The Microhydropower Calculator was built by
+                            <a href="http://www.civicmapper.com">CivicMapper</a> on behalf of
+                            <a href="http://spatialanalytixllc.com/">Spatial Analytix LLC</a>, for
+                            <a href="http://www.bard.edu/">Bard College</a> and
+                            <a href="http://www.currenthydro.com/">Current Hydro LLC</a>.</p>
+                    </div>
+                    <div id="methods" class="tab-pane">
+                        {% filter markdown %} {% include 'pages/help_methods.md' %} {% endfilter %}
+                    </div>
+                </div>
+            </div>
+            <div class="modal-footer">
+                <button type="button" class="btn btn-default" data-dismiss="modal">Close</button>
+            </div>
+        </div>
+    </div>
+</div>

app/static/assets/currenthydro.png

@@ -0,0 +1,31 @@
+
+[Current Hydro](http://www.currenthydro.com/) provides an overview of microhydropower technology on their website.
+
+This tool uses a basic formula for estimating power generation potential; it is suitable for planning purposes only.
+
+#### Variables
+
+* `A` = area of the watershed upstream of the microhydropower installation, in `square miles`. This helps determine the volume of water that could pass through the turbine. This tool automatically determines this value from geospatial data (you have the option to override that).
+* `H` = head (elevation change) for the microhydropower installation in `feet`; the drop in elevation helps determine how much energy the turbine will be able to generate. This tool automatically determines this value from geospatial data (you have the option to override that).
+* `Y` = watershed yield, as `cubic feet per second per square mile` (`cfs/sqmi`). We use 1.6 cfs/sqmi as a constant as a general estimate of the amount of water per square mile a watershed will yield, which is good enough for planning purposes.
+* `F` = an environmental flow constant, typically between 0.1 and 0.5 `cfs/sqmi`. Our default is 0.3.
+* `E` = a power generation efficiency constant. Our default is 70%.
+* `R` = electricity value per kilowatt-hour, in dollars
+* `P` = power generated, in kilowatt-hours
+* `V` = annual value of power generated, in dollars
+
+#### Calculation
+
+##### Estimate potential watershed yield 
+
+  * `Qt = A * Y` (cubic feet per second)
+  * `Qe = A * F` (cubic feet per second)
+  * `Qu = Qt - Qe` useable yield from the watershed (cubic feet per second)
+
+#### Calculate Power Generation
+
+  * `P = (Qu * H / 11.8) x e` power generated, in kilowatt-hours
+
+#### Calculate Power Value
+
+  * `V = R * 8766 * P` annual value of power generated, in dollars