honeybee-schema

honeybee-schema

Honeybee Data-Model Objects

This code was partially developed under the Wells Fargo Innovation Incubator grant with help from the OpenStudio Team at NREL.

Installation

To install the core library use:

pip install -U honeybee-schema

If you want to also include the command line interface use:

pip install -U honeybee-schema[cli]

QuickStart

import honeybee_schema

API Documentation

Schema Overview

Model Schema Specification

Energy Simulation Parameter Schema Specification

Local Development

1. Clone this repo locally

git clone [e-mail]:ladybug-tools/honeybee-schema

# or

git clone https://github.com/ladybug-tools/honeybee-schema

1. Install dependencies:

cd honeybee-schema
pip install -r dev-requirements.txt
pip install -r requirements.txt

1. Run Tests:

python -m pytest tests/

1. Generate Documentation:

python ./docs.py

1. Generate Sample Files:

python ./scripts/export_samples.py