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

:honeybee: :scroll: HBJSON format schema
https://github.com/ladybug-tools/honeybee-schema

Last synced: 4 months ago
JSON representation

:honeybee: :scroll: HBJSON format schema

• Host: GitHub
• URL: https://github.com/ladybug-tools/honeybee-schema
• Owner: ladybug-tools
• License: other
• Created: 2019-12-08T02:10:52.000Z (over 6 years ago)
• Default Branch: master
• Last Pushed: 2025-08-21T03:04:37.000Z (10 months ago)
• Last Synced: 2025-08-21T03:23:24.936Z (10 months ago)
• Language: Python
• Homepage: https://ladybug-tools.github.io/honeybee-schema
• Size: 60.1 MB
• Stars: 13
• Watchers: 6
• Forks: 11
• Open Issues: 6
• Metadata Files:
  • Readme: README.md
  • Contributing: CONTRIBUTING.md
  • License: LICENSE
  • Code of conduct: CODE_OF_CONDUCT.md

Awesome Lists containing this project

README

          
[![Build Status](https://travis-ci.com/ladybug-tools/honeybee-schema.svg?branch=master)](https://travis-ci.com/ladybug-tools/honeybee-schema)

[![Coverage Status](https://coveralls.io/repos/github/ladybug-tools/honeybee-schema/badge.svg?branch=master)](https://coveralls.io/github/ladybug-tools/honeybee-schema)

[![Python 3.7](https://img.shields.io/badge/python-3.7-blue.svg)](https://www.python.org/downloads/release/python-370/)

# honeybee-schema

Honeybee Data-Model Objects

This code was partially developed under the [Wells Fargo Innovation Incubator grant](https://newsroom.wf.com/press-release/community/five-clean-tech-startups-added-wells-fargo-innovation-incubator) with help from the

[OpenStudio Team](https://github.com/NREL/OpenStudio) at [NREL](https://www.nrel.gov/).

# 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

```python

import honeybee_schema

```

## API Documentation

[Schema Overview](https://github.com/ladybug-tools/honeybee-schema/wiki)

[Model Schema Specification](https://ladybug-tools.github.io/honeybee-schema/model.html)

[Energy Simulation Parameter Schema Specification](https://ladybug-tools.github.io/honeybee-schema/simulation-parameter.html)

## Local Development

1. Clone this repo locally

```console

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

# or

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

```

2. Install dependencies:

```console

cd honeybee-schema

pip install -r dev-requirements.txt

pip install -r requirements.txt

```

3. Run Tests:

```console

python -m pytest tests/

```

4. Generate Documentation:

```python

python ./docs.py

```

5. Generate Sample Files:

```python

python ./scripts/export_samples.py

```