Skip to content

Commit

Permalink
Updated README to match current version
Browse files Browse the repository at this point in the history
There were some small differences between the README description of
the program and it's current behavior. These differences have been
resolved in this commit.
  • Loading branch information
vanderwb committed Apr 16, 2018
1 parent 1368110 commit 436ba02
Showing 1 changed file with 11 additions and 3 deletions.
14 changes: 11 additions & 3 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,9 +1,14 @@
# Python Weather Generator

**Author: Brian Vanderwende**
**Version: beta1**
**Version: 1.0**

This weather generator creates a sample forecast for Boulder, CO. Daily values are produced for high temperature, low temperature, and accumulated precipitation.
This weather generator creates a sample forecast for multiple cities. Currently, forecasts are produced for:

+ Boulder, CO
+ Philadelphia, PA

Daily values are produced for high temperature, low temperature, and accumulated precipitation.

### Requirements

Expand All @@ -17,6 +22,8 @@ The weather generator features the following tunable parameters:
+ Mean and standard deviation values for Gaussian distributions
+ Chance of precipitation on any particular day

These parameters are set for each city in JSON format in the "cities" directory.

### How to Run

Simply execute the script:
Expand All @@ -25,10 +32,11 @@ Simply execute the script:
./wxgen.py
```

The forecast will be written to a file in the "forecasts" directory:
The forecasts will be written to files in the "forecasts" directory:

```
Forecast for Boulder, CO
Generated at 2134Z - 13 Apr 2018
Day 1
High: 12.33 deg C
Expand Down

0 comments on commit 436ba02

Please sign in to comment.