BRICR Gem
Prerequisites
In order to run the BRICR gem, OpenStudio and Ruby are required. Follow the guidelines as specified in the openstudio-extension-gem. The following is added as additional helpful information based on troubles encountered. It has been tested on Windows 10 installs:
-
The devkit link will download a zip file. This needs to be extracted (doesn't matter where, can remain in Downloads).
-
After extracting, edit the
config.ymlfile, adding the drive location for where ruby is installed (likely as stated below). Include the-at the beginning, as follows:# config.yml - C:/Ruby22-x64 -
Then, run the devkit scripts:
$ ruby dk.rb init $ ruby dk.rb install
-
-
If an error occurs on
gem install bundler -v 17.1, trygem install bundler -v 17.1.1. If you are getting an SSL error (Unable to download data from https://rubygems.org/ - SSL_connect returned=1...), try the following:- Add a
.gemrcfile to your home directory (C:/Users/my_user/.gemrc) with the following::sources: - http://rubygems.org :ssl_verify_mode: 0
- Add a
-
You MUST use OpenStudio-2.8.1
-
Make sure when adding this file:
C:\ruby-2.2.4-x64-mingw32\lib\ruby\site_ruby\openstudio.rb, you use the correct OpenStudio version, i.e.require 'C:\openstudio-2.8.1\Ruby\openstudio.rb' -
Make sure to verify the OpenStudio and Ruby configuration.
If all the above steps completed successfully, you should be able to move onto Installation.
Installation
Clone this repo locally. Install dependencies:
bundle install
bundle update
Configure locations to instance of SEED by copying config.rb.in to config.rb and updating. The following fields need to be specified:
ENV['BRICR_SEED_HOST']
ENV['BRICR_SEED_USERNAME']
ENV['BRICR_SEED_API_KEY']
ENV['BRICR_SEED_ORGANIZATION']
ENV['BRICR_SEED_CYCLE']
ENV['BRICR_SEED_SEARCH_PROFILE']Changing these will allow you to run the scripts by pointing at different instances of SEED.
Usage
To convert all geojson to buildingsync files. Outputs will be added to ‘bs_output’ in root bricr dir
$ bundle exec geojson_to_buildingsync.rb ./data/my.geojson
Upload BuildingSync xml file (4.xml) to SEED (as specified in config.rg). Defines the ‘Analysis State’ as not started.
$ bundle exec ruby bin/upload_seed_buildingsync.rb ./config.rb bs_output/4.xml 'Not Started’
Pulls from SEED all properties with 'Analysis State' == 'Not Started'. Converts BuildingSync XML to an OS Model and creates OS Workflow. Runs baseline simulation and measures / scenarios. Converts back to BuildingSync XML and then reuploads to SEED, hopefully with an analysis state of 'Completed'.
$ bundle exec ruby ./bin/run_seed_buildingsyncs.rb ./config.rb
Service to monitor SEED, and basically perform the exact same thing as run_seed_buildingsyncs.rb. Only difference is that this is an 'active server' type application, which pings seed every once in a while to see if new buildings have been uploaded.
$ bundle exec ruby ./bin/monitor_seed.rb ./config.rb
Locally
Run all tests:
bundle exec rspec
Run a specific test (LINE = line number for the test):
bundle exec rspec spec\tests\translator_spec.rb:LINE
Contributing
- Fork it ( https://github.com/NREL/bricr/fork )
- Create your feature branch (
git checkout -b my-new-feature) - Commit your changes (
git commit -am 'Add some feature') - Push to the branch (
git push origin my-new-feature) - Create a new Pull Request
React
Typescript
Django
Laravel
Facebook
Microsoft
Google
Alibaba
D3
Tencent