honeybee-schema 1.9.0

Honeybee Data-Model Objects

honeybee-schema

Honeybee Data-Model Objects

Installation

pip install honeybee-schema

QuickStart

import honeybee_schema

API Documentation

Model Schema

Energy Simulation Parameter Schema

Local Development

1. Clone this repo locally

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

# or

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

2. Install dependencies:

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

3. Run Tests:

python -m pytest tests/

4. Generate Documentation:

python ./docs.py

5. Generate Sample Files:

python ./scripts/export_samples.py

6. Validate a Model:

python ./validate_model.py ./honeybee_schema/samples/model_complete_multi_zone_office.json

Note that ./honeybee_schema/samples/model_complete_multi_zone_office.json should be replaced with the path to the specific model JSON that you would like to validate.

Note that you should have honeybee and its extensions installed in order to run a complete validation that includes re-serialization of the Model.