Skip to main content

Honeybee Data-Model Objects

Project description

Build Status Coverage Status

Python 3.7

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 git@github.com: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

Project details


Release history Release notifications | RSS feed

Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

honeybee-schema-1.50.3.tar.gz (33.0 MB view hashes)

Uploaded source

Built Distribution

honeybee_schema-1.50.3-py2.py3-none-any.whl (66.9 kB view hashes)

Uploaded py2 py3

Supported by

AWS AWS Cloud computing Datadog Datadog Monitoring Facebook / Instagram Facebook / Instagram PSF Sponsor Fastly Fastly CDN Google Google Object Storage and Download Analytics Huawei Huawei PSF Sponsor Microsoft Microsoft PSF Sponsor NVIDIA NVIDIA PSF Sponsor Pingdom Pingdom Monitoring Salesforce Salesforce PSF Sponsor Sentry Sentry Error logging StatusPage StatusPage Status page