dragonfly-core


Namedragonfly-core JSON
Version 1.29.57 PyPI version JSON
download
home_pagehttps://github.com/ladybug-tools/dragonfly-core
Summary:dragon: dragonfly core library
upload_time2021-09-27 13:12:04
maintainer
docs_urlNone
authorLadybug Tools
requires_python
licenseAGPL-3.0
keywords
VCS
bugtrack_url
requirements No requirements were recorded.
Travis-CI No Travis.
coveralls test coverage No coveralls.
            [![Build Status](https://travis-ci.com/ladybug-tools/dragonfly-core.svg?branch=master)](https://travis-ci.com/ladybug-tools/dragonfly-core)
[![Coverage Status](https://coveralls.io/repos/github/ladybug-tools/dragonfly-core/badge.svg?branch=master)](https://coveralls.io/github/ladybug-tools/dragonfly-core)

[![Python 3.7](https://img.shields.io/badge/python-3.7-blue.svg)](https://www.python.org/downloads/release/python-370/) [![Python 2.7](https://img.shields.io/badge/python-2.7-green.svg)](https://www.python.org/downloads/release/python-270/) [![IronPython](https://img.shields.io/badge/ironpython-2.7-red.svg)](https://github.com/IronLanguages/ironpython2/releases/tag/ipy-2.7.8/)

# dragonfly-core

![Screenshot](https://github.com/chriswmackey/Dragonfly/blob/master/dragonfly.png)

Dragonfly is a collection of Python libraries to create representations of buildings
following [dragonfly-schema](https://github.com/ladybug-tools/dragonfly-schema/wiki).
It abstracts the capabilities of [honeybee-core](https://github.com/ladybug-tools/honeybee-core/)
to make it easier to construct models on the urban scale.

This repository is the core repository that provides dragonfly's common functionalities.
To extend these functionalities you should install available Dragonfly extensions or write
your own.

Here are a number of frequently used extensions for Dragonfly:
- [dragonfly-energy](https://github.com/ladybug-tools/dragonfly-energy): Adds Energy simulation to Dragonfly.

## Installation

`pip install -U dragonfly-core`

To check if Dragonfly command line interface is installed correctly use `dragonfly viz` and you
should get a `viiiiiiiiiiiiizzzzzzzzz!` back in response!

## [API Documentation](https://www.ladybug.tools/dragonfly-core/docs/)

## Local Development
1. Clone this repo locally
```console
git clone git@github.com:ladybug-tools/dragonfly-core.git

# or

git clone https://github.com/ladybug-tools/dragonfly-core.git
```
2. Install dependencies:
```console
cd dragonfly-core
pip install -r dev-requirements.txt
pip install -r requirements.txt
```

3. Run Tests:
```console
python -m pytests tests/
```

4. Generate Documentation:
```console
sphinx-apidoc -f -e -d 4 -o ./docs ./dragonfly
sphinx-build -b html ./docs ./docs/_build/docs
```



            

Raw data

            {
    "_id": null,
    "home_page": "https://github.com/ladybug-tools/dragonfly-core",
    "name": "dragonfly-core",
    "maintainer": "",
    "docs_url": null,
    "requires_python": "",
    "maintainer_email": "",
    "keywords": "",
    "author": "Ladybug Tools",
    "author_email": "info@ladybug.tools",
    "download_url": "https://files.pythonhosted.org/packages/6c/ec/06c9ad1485e5fce830f9a2fd6416498567481710f0bcc99d5dffbaa30d77/dragonfly-core-1.29.57.tar.gz",
    "platform": "",
    "description": "[![Build Status](https://travis-ci.com/ladybug-tools/dragonfly-core.svg?branch=master)](https://travis-ci.com/ladybug-tools/dragonfly-core)\n[![Coverage Status](https://coveralls.io/repos/github/ladybug-tools/dragonfly-core/badge.svg?branch=master)](https://coveralls.io/github/ladybug-tools/dragonfly-core)\n\n[![Python 3.7](https://img.shields.io/badge/python-3.7-blue.svg)](https://www.python.org/downloads/release/python-370/) [![Python 2.7](https://img.shields.io/badge/python-2.7-green.svg)](https://www.python.org/downloads/release/python-270/) [![IronPython](https://img.shields.io/badge/ironpython-2.7-red.svg)](https://github.com/IronLanguages/ironpython2/releases/tag/ipy-2.7.8/)\n\n# dragonfly-core\n\n![Screenshot](https://github.com/chriswmackey/Dragonfly/blob/master/dragonfly.png)\n\nDragonfly is a collection of Python libraries to create representations of buildings\nfollowing [dragonfly-schema](https://github.com/ladybug-tools/dragonfly-schema/wiki).\nIt abstracts the capabilities of [honeybee-core](https://github.com/ladybug-tools/honeybee-core/)\nto make it easier to construct models on the urban scale.\n\nThis repository is the core repository that provides dragonfly's common functionalities.\nTo extend these functionalities you should install available Dragonfly extensions or write\nyour own.\n\nHere are a number of frequently used extensions for Dragonfly:\n- [dragonfly-energy](https://github.com/ladybug-tools/dragonfly-energy): Adds Energy simulation to Dragonfly.\n\n## Installation\n\n`pip install -U dragonfly-core`\n\nTo check if Dragonfly command line interface is installed correctly use `dragonfly viz` and you\nshould get a `viiiiiiiiiiiiizzzzzzzzz!` back in response!\n\n## [API Documentation](https://www.ladybug.tools/dragonfly-core/docs/)\n\n## Local Development\n1. Clone this repo locally\n```console\ngit clone git@github.com:ladybug-tools/dragonfly-core.git\n\n# or\n\ngit clone https://github.com/ladybug-tools/dragonfly-core.git\n```\n2. Install dependencies:\n```console\ncd dragonfly-core\npip install -r dev-requirements.txt\npip install -r requirements.txt\n```\n\n3. Run Tests:\n```console\npython -m pytests tests/\n```\n\n4. Generate Documentation:\n```console\nsphinx-apidoc -f -e -d 4 -o ./docs ./dragonfly\nsphinx-build -b html ./docs ./docs/_build/docs\n```\n\n\n",
    "bugtrack_url": null,
    "license": "AGPL-3.0",
    "summary": ":dragon: dragonfly core library",
    "version": "1.29.57",
    "split_keywords": [],
    "urls": [
        {
            "comment_text": "",
            "digests": {
                "md5": "5d89264dfc987e56d53349756737edb3",
                "sha256": "cdc31707e63163b9a4e0a4322379ad783f3bd79ef4f67899ad42c3882d24277a"
            },
            "downloads": -1,
            "filename": "dragonfly_core-1.29.57-py2.py3-none-any.whl",
            "has_sig": false,
            "md5_digest": "5d89264dfc987e56d53349756737edb3",
            "packagetype": "bdist_wheel",
            "python_version": "py2.py3",
            "requires_python": null,
            "size": 94495,
            "upload_time": "2021-09-27T13:12:01",
            "upload_time_iso_8601": "2021-09-27T13:12:01.882340Z",
            "url": "https://files.pythonhosted.org/packages/6e/5b/fef5fffaad5919099272f51639afbbc8beb08b0508013b9c58985976c93d/dragonfly_core-1.29.57-py2.py3-none-any.whl",
            "yanked": false,
            "yanked_reason": null
        },
        {
            "comment_text": "",
            "digests": {
                "md5": "b2cc7bf53157dd2b8ebe129d6b8d7f0b",
                "sha256": "a2d6989f2b94658462d3f875a2deaff3bb73e63fa3be641568cfabfd52ace27b"
            },
            "downloads": -1,
            "filename": "dragonfly-core-1.29.57.tar.gz",
            "has_sig": false,
            "md5_digest": "b2cc7bf53157dd2b8ebe129d6b8d7f0b",
            "packagetype": "sdist",
            "python_version": "source",
            "requires_python": null,
            "size": 119558,
            "upload_time": "2021-09-27T13:12:04",
            "upload_time_iso_8601": "2021-09-27T13:12:04.160006Z",
            "url": "https://files.pythonhosted.org/packages/6c/ec/06c9ad1485e5fce830f9a2fd6416498567481710f0bcc99d5dffbaa30d77/dragonfly-core-1.29.57.tar.gz",
            "yanked": false,
            "yanked_reason": null
        }
    ],
    "upload_time": "2021-09-27 13:12:04",
    "github": true,
    "gitlab": false,
    "bitbucket": false,
    "github_user": "ladybug-tools",
    "github_project": "dragonfly-core",
    "travis_ci": false,
    "coveralls": false,
    "github_actions": true,
    "requirements": [],
    "lcname": "dragonfly-core"
}
        
Elapsed time: 0.27411s