Skip to content

Commit

Permalink
add a little info about how to install from npm
Browse files Browse the repository at this point in the history
  • Loading branch information
agilliland authored Apr 3, 2017
1 parent 3f3d1b6 commit e5657e4
Showing 1 changed file with 13 additions and 0 deletions.
13 changes: 13 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,8 +8,21 @@ An implementation of ISO 13790-2008 and limited to only single-zone building def

# Installation (npm)

```
npm install --save buildzero-energy-model
```

# Usage

```
var EnergyModel = require('buildzero-energy-model');
// check out the example.js file to see what the input data structures are meant to look like.
// better docs coming once things are more finalized.
var modelResults = EnergyModel.thermalDemand(buildingSettings, hourlyConditions, buildingElements, climateData);
```


# License

Unless otherwise specified all BuildZero.org source files are made available under the terms of the MIT License (MIT). See [LICENSE.txt](https://github.com/buildzero/energy-model/blob/master/LICENSE.txt) for details.
Expand Down

0 comments on commit e5657e4

Please sign in to comment.