Library and measures for translating between Honeybee JSON schema and OpenStudio Model schema (OSM).
Running the measures using OpenStudio CLI requires no installation other than cloning this repo and installing OpenStudio.
{
"measure_paths": [(PATH TO THIS REPOSITORY)/lib/measures"],
"steps": [
{
"arguments": {"model_json": (PATH TO MODEL JSON)},
"measure_dir_name": "from_honeybee_model"
},
{
"arguments": {"simulation_parameter_json": (PATH TO SIMULATION PARAMETER JSON)},
"measure_dir_name": "from_honeybee_simulation_parameter"
}
]
}
-I
(or --include
) option. Here is a sample
where the items in parentheses should be replaced with specific file paths:"(OPENSTUDIO INSTALLATION PATH)/bin/openstudio.exe" -I (PATH TO THIS REPOSITORY)/lib run -m -w (PATH TO OSW FILE)
git clone git@github.com:ladybug-tools/honeybee-openstudio-gem
git clone https://github.com/ladybug-tools/honeybee-openstudio-gem
2. Install dependencies:
First install the OpenStudio Extension Gem following the
[installation instructions on the gem's github](https://github.com/NREL/openstudio-extension-gem#installation)
This will involve both the installation of OpenStudio and Ruby.
Then, you must install the OpenStudio Extension Gem itself with:
gem install openstudio-extension
Then, the specific dependencies of this repository can be installed by running:
cd honeybee-openstudio-gem bundle update
3. Run Core Library Tests:
cd honeybee-openstudio-gem bundle exec rake
4. Run Measure Tests:
cd honeybee-openstudio-gem/lib/measures/from_honeybee_model/tests/ bundle exec ruby from_honeybee_model_test.rb
cd honeybee-openstudio-gem/lib/measures/from_honeybee_simulation_parameter/tests/ bundle exec ruby from_honeybee_simulation_parameter_test.rb
5. Update doc_templates:
cd honeybee-openstudio-gem bundle exec rake openstudio:update_copyright
6. See all available rake tasks:
cd honeybee-openstudio-gem bundle exec rake -T