From d8275e334cb9c5845776100e3a0cfb1a9774379e Mon Sep 17 00:00:00 2001 From: Josh Wentz Date: Mon, 28 Apr 2014 23:40:59 -0400 Subject: [PATCH] Update documentation --- README.md | 8 ++++---- jason/README.md | 7 ++++--- 2 files changed, 8 insertions(+), 7 deletions(-) diff --git a/README.md b/README.md index 6972199..a70a2d3 100644 --- a/README.md +++ b/README.md @@ -1,6 +1,6 @@ OpenStudio Node.js ================== -This app uses Node.js Bindings of OpenStudio to enable web-based building energy simulations coded entirely in 1 language: JavaScript. +This app uses Node.js Bindings of OpenStudio to enable web-based building energy simulations coded entirely in one language: JavaScript. http://node.eebhub.org @@ -8,10 +8,10 @@ Background --------- This project began by porting a minimum version of the DOE Energy Efficient Building Hub's [Retrofit Manager Tool](http://tools.eebhub.org/comprehensive). This predecessor app comprised JavaScript, PHP, and Ruby. Each additional programming language expanded the potential for error and increased the difficulty to train new team members. The main objective of OpenStudio Node.js was to simplify the software into 1 language. -* **OpenStudio** = a software development kit to support whole building energy modeling using EnergyPlus and advanced daylight analysis using Radiance [developed by the National Renewable Energy Laboratory (NREL)] +* **OpenStudio** = a software development kit to support whole building energy modeling using EnergyPlus and advanced daylight analysis using Radiance (developed by NREL) * **Node.js** = a server-side implementation of JavaScript running on Google's V8 Engine -Today, the working web application above uses 1 language, JavaScript, on both the front-end (browser) and back-end (server). +Today, the working web application above uses one language, JavaScript, on both the front-end (browser) and back-end (server). Learn More at http://www.buildsci.us/openstudio-nodejs.html. @@ -20,7 +20,7 @@ Steps to Learn 1. [Install OpenStudio & EnergyPlus](https://github.com/buildsci/energyplus.io/tree/develop/installers) on Ubuntu Linux 12.04 (only currently supported operating system) 2. [Install Node.js](http://joshwentz.blogspot.com/2013/05/install-nodejs-on-ubuntu-1204.html) 3. [**Run OpenStudio with Node.js**](https://github.com/eebhub/openstudio_nodejs/tree/develop/library): minimum version requires only 3 files -4. [**Run OpenStudio Ruby Measures with Node.js**](https://github.com/eebhub/openstudio_nodejs/tree/develop/jason): shows how to add 3 measures from NREL's Building Component Library) +4. [**Run OpenStudio Ruby Measures with Node.js**](https://github.com/eebhub/openstudio_nodejs/tree/develop/jason): shows how to add 3 measures from NREL's Building Component Library Software Stack -------------- diff --git a/jason/README.md b/jason/README.md index d7276a6..113d64c 100644 --- a/jason/README.md +++ b/jason/README.md @@ -5,9 +5,10 @@ Run OpenStudio Ruby Measures from Node.js Energy Efficiency Measures ------------------------- For this project, we focused on 3 measures: -1. [Reduce Lighting Loads by Percentage](https://bcl.nrel.gov/node/37875), ([code](https://github.com/eebhub/openstudio_nodejs/tree/develop/jason/measures/ReduceLightingLoadsByPercentage)) -2. [Set Window to Wall Ratio by Facade](https://bcl.nrel.gov/node/37880), ([code](https://github.com/eebhub/openstudio_nodejs/tree/develop/jason/measures/SetWindowToWallRatioByFacade)) -3. [Add Output Variable](https://bcl.nrel.gov/node/37843), ([code](https://github.com/eebhub/openstudio_nodejs/tree/develop/jason/measures/AddOutputVariable)) + + 1. [Reduce Lighting Loads by Percentage](https://bcl.nrel.gov/node/37875), ([code](https://github.com/eebhub/openstudio_nodejs/tree/develop/jason/measures/ReduceLightingLoadsByPercentage)) + 2. [Set Window to Wall Ratio by Facade](https://bcl.nrel.gov/node/37880), ([code](https://github.com/eebhub/openstudio_nodejs/tree/develop/jason/measures/SetWindowToWallRatioByFacade)) + 3. [Add Output Variable](https://bcl.nrel.gov/node/37843), ([code](https://github.com/eebhub/openstudio_nodejs/tree/develop/jason/measures/AddOutputVariable)) Add Measure to OpenStudio Model ---------------------------