add more to readme

Author: ardunn

README.md

@@ -1,8 +1,48 @@
 # wdash
-a weather dashboard built from OpenWeatherMaps APi, MongoDB, and Plotly Dash
+a weather dashboard built from OpenWeatherMaps APi, MongoDB, Windy, and Plotly Dash
 
 
-todo: 
+![demo](demo.gif)
+
+
+# Configure
+
+All the variables needed to configure `wdash` are in `config.yml`.
+
+## `CITY_ID`
+The city ID (an integer) for your city as per [OpenWeatherMaps search API](https://openweathermap.org/find). Enter your city and country name and the resulting url (e.g., https://openweathermap.org/city/5403676) contains the integer city ID (in this example, 5403676).
+
+
+## `DB_HOST`
+The host of your mongodb instance, e.g., `localhost`
+
+## `DB_PORT`
+The port of your mongodb instance, e.g., 27017
+
+## `DB_NAME`
+The name of the mongodb database you'd like to use or create to hold your wdash data, e.g., `wdash`
+
+## `INTERVAL`
+The inteval to update (gather current weathers and forecasts), in seconds. The default `1800` corresponds to  every 30 minutes.
+
+## `PORT`
+The port you'd like the `wdash` interface to run on.
+
+## `API_KEY`
+Your OpenWeatherMaps API key. Only the free-tier API key is required for full functionality.
+
+## `WINDY_EMBED`
+The embeddable url for your windy map, which you can obtain from [Windy](https://www.windy.com/-Embed-widget-on-page/widgets?39.339,-120.173,5)
+
+
+# Running `wdash`
+
+Simply run
+
+
+```
+source run.sh
+```
+
+In the `wdash` directory for the daemon and app to run in the background. All output will be logged to `log.txt` in the `wdash` directory.
 
-- add weather codes to heatmap: https://openweathermap.org/weather-conditions
-- fix app title

app.py

@@ -27,6 +27,8 @@
 NAME = CONFIG["DB_NAME"]
 INTERVAL = CONFIG["INTERVAL"]
 SERVER_PORT = CONFIG["PORT"]
+WINDY_EMBED = CONFIG["WINDY_EMBED"]
+
 
 mc = MongoClient(host=HOST, port=PORT)
 cw = mc[NAME].weather_current
@@ -574,7 +576,7 @@ def generate_page(n_intervals):
     common_style = {"width": "95%", "height": "700px", "margin": "auto", "border": "30px"}
     widget = html.Iframe(
         style=common_style,
-        src="https://embed.windy.com/embed2.html?lat=39.339&lon=-120.173&detailLat=39.339&detailLon=-120.173&width=650&height=450&zoom=5&level=surface&overlay=wind&product=ecmwf&menu=&message=&marker=&calendar=now&pressure=&type=map&location=coordinates&detail=&metricWind=mph&metricTemp=%C2%B0F&radarRange=-1"
+        src=WINDY_EMBED
     )
 
 

config.yml

@@ -1,9 +1,9 @@
 CITY_ID: 5403676
-TZ: "US/Pacific"
 DB_HOST: "localhost"
 DB_PORT: 27017
 DB_NAME: "wdash"
 INTERVAL: 1800
 PORT: 57042
 # Your api key goes here
 API_KEY: ""
+WINDY_EMBED: "https://embed.windy.com/embed2.html?lat=39.339&lon=-120.173&detailLat=39.339&detailLon=-120.173&width=650&height=450&zoom=5&level=surface&overlay=wind&product=ecmwf&menu=&message=&marker=&calendar=now&pressure=&type=map&location=coordinates&detail=&metricWind=mph&metricTemp=%C2%B0F&radarRange=-1"

daemon.py

@@ -16,7 +16,6 @@
 HOST = CONFIG["DB_HOST"]
 PORT = CONFIG["DB_PORT"]
 NAME = CONFIG["DB_NAME"]
-TZ = CONFIG["TZ"]
 INTERVAL = CONFIG["INTERVAL"]
 CITY_ID = CONFIG["CITY_ID"]
 API_KEY = CONFIG["API_KEY"]
@@ -26,7 +25,6 @@
 cf = mc[NAME].weather_forecasted
 owm = OWM(API_KEY)
 mgr = owm.weather_manager()
-TZ_PYTZ = pytz.timezone(TZ)
 TIMEOUT_INTERVAL = 60          # seconds
 handler = logging.StreamHandler()
 formatter = logging.basicConfig(format='%(asctime)s %(levelname)s %(message)s', level=logging.INFO)