honeybee-schema


Namehoneybee-schema JSON
Version 1.58.5 PyPI version JSON
download
home_pagehttps://github.com/ladybug-tools-in2/honeybee-schema
SummaryHoneybee Data-Model Objects
upload_time2024-10-17 01:22:11
maintainerNone
docs_urlNone
authorLadybug Tools
requires_pythonNone
licenseNone
keywords
VCS
bugtrack_url
requirements No requirements were recorded.
Travis-CI No Travis.
coveralls test coverage
            [![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
```

            

Raw data

            {
    "_id": null,
    "home_page": "https://github.com/ladybug-tools-in2/honeybee-schema",
    "name": "honeybee-schema",
    "maintainer": null,
    "docs_url": null,
    "requires_python": null,
    "maintainer_email": null,
    "keywords": null,
    "author": "Ladybug Tools",
    "author_email": "info@ladybug.tools",
    "download_url": "https://files.pythonhosted.org/packages/d7/fd/655450c844a3df1085fdbe98c984cf775468f02be9ac2e89139bd1f46916/honeybee_schema-1.58.5.tar.gz",
    "platform": null,
    "description": "[![Build Status](https://travis-ci.com/ladybug-tools/honeybee-schema.svg?branch=master)](https://travis-ci.com/ladybug-tools/honeybee-schema)\n[![Coverage Status](https://coveralls.io/repos/github/ladybug-tools/honeybee-schema/badge.svg?branch=master)](https://coveralls.io/github/ladybug-tools/honeybee-schema)\n\n[![Python 3.7](https://img.shields.io/badge/python-3.7-blue.svg)](https://www.python.org/downloads/release/python-370/)\n\n# honeybee-schema\n\nHoneybee Data-Model Objects\n\nThis 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\n[OpenStudio Team](https://github.com/NREL/OpenStudio) at [NREL](https://www.nrel.gov/).\n\n# Installation\n\nTo install the core library use:\n\n`pip install -U honeybee-schema`\n\nIf you want to also include the command line interface use:\n\n`pip install -U honeybee-schema[cli]`\n\n## QuickStart\n\n```python\nimport honeybee_schema\n\n```\n\n## API Documentation\n\n[Schema Overview](https://github.com/ladybug-tools/honeybee-schema/wiki)\n\n[Model Schema Specification](https://ladybug-tools.github.io/honeybee-schema/model.html)\n\n[Energy Simulation Parameter Schema Specification](https://ladybug-tools.github.io/honeybee-schema/simulation-parameter.html)\n\n## Local Development\n\n1. Clone this repo locally\n\n```console\ngit clone git@github.com:ladybug-tools/honeybee-schema\n\n# or\n\ngit clone https://github.com/ladybug-tools/honeybee-schema\n```\n\n2. Install dependencies:\n\n```console\ncd honeybee-schema\npip install -r dev-requirements.txt\npip install -r requirements.txt\n```\n\n3. Run Tests:\n\n```console\npython -m pytest tests/\n```\n\n4. Generate Documentation:\n\n```python\npython ./docs.py\n```\n\n5. Generate Sample Files:\n\n```python\npython ./scripts/export_samples.py\n```\n",
    "bugtrack_url": null,
    "license": null,
    "summary": "Honeybee Data-Model Objects",
    "version": "1.58.5",
    "project_urls": {
        "Homepage": "https://github.com/ladybug-tools-in2/honeybee-schema"
    },
    "split_keywords": [],
    "urls": [
        {
            "comment_text": "",
            "digests": {
                "blake2b_256": "6ed67a7c69739db6da16a36517c6a82e78418a8fc31cadf36d5440b9210550cb",
                "md5": "cd5711ae9f37247f0dbad64d9c433c56",
                "sha256": "6321c81f030244801db64eb589cc2295d5618974d75bebb11807e3a201d04be7"
            },
            "downloads": -1,
            "filename": "honeybee_schema-1.58.5-py2.py3-none-any.whl",
            "has_sig": false,
            "md5_digest": "cd5711ae9f37247f0dbad64d9c433c56",
            "packagetype": "bdist_wheel",
            "python_version": "py2.py3",
            "requires_python": null,
            "size": 84143,
            "upload_time": "2024-10-17T01:22:10",
            "upload_time_iso_8601": "2024-10-17T01:22:10.817993Z",
            "url": "https://files.pythonhosted.org/packages/6e/d6/7a7c69739db6da16a36517c6a82e78418a8fc31cadf36d5440b9210550cb/honeybee_schema-1.58.5-py2.py3-none-any.whl",
            "yanked": false,
            "yanked_reason": null
        },
        {
            "comment_text": "",
            "digests": {
                "blake2b_256": "d7fd655450c844a3df1085fdbe98c984cf775468f02be9ac2e89139bd1f46916",
                "md5": "0ee4723ea4f368935cbf264e8d359d58",
                "sha256": "8d9aa3329ce6157cb94b57786205760288a5518a44c9f12b39cbe22aff76d38c"
            },
            "downloads": -1,
            "filename": "honeybee_schema-1.58.5.tar.gz",
            "has_sig": false,
            "md5_digest": "0ee4723ea4f368935cbf264e8d359d58",
            "packagetype": "sdist",
            "python_version": "source",
            "requires_python": null,
            "size": 65713,
            "upload_time": "2024-10-17T01:22:11",
            "upload_time_iso_8601": "2024-10-17T01:22:11.949370Z",
            "url": "https://files.pythonhosted.org/packages/d7/fd/655450c844a3df1085fdbe98c984cf775468f02be9ac2e89139bd1f46916/honeybee_schema-1.58.5.tar.gz",
            "yanked": false,
            "yanked_reason": null
        }
    ],
    "upload_time": "2024-10-17 01:22:11",
    "github": true,
    "gitlab": false,
    "bitbucket": false,
    "codeberg": false,
    "github_user": "ladybug-tools-in2",
    "github_project": "honeybee-schema",
    "travis_ci": false,
    "coveralls": true,
    "github_actions": true,
    "requirements": [],
    "lcname": "honeybee-schema"
}
        
Elapsed time: 0.70978s