dragonfly-doe2

Name	dragonfly-doe2 JSON
Version	0.11.3 JSON
	download
home_page	https://github.com/ladybug-tools/dragonfly-doe2
Summary	Dragonfly extension for the DOE-2 energy simulation engine.
upload_time	2022-10-28 23:55:46
maintainer
docs_url	None
author	Ladybug Tools
requires_python
license	AGPL-3.0
keywords
VCS
bugtrack_url
requirements	dragonfly-energy
Travis-CI	No Travis.
coveralls test coverage	No coveralls.

            ![Dragonfly](https://www.ladybug.tools/assets/img/dragonfly.png)

[![Build Status](https://github.com/ladybug-tools/dragonfly-doe2/workflows/CI/badge.svg)](https://github.com/ladybug-tools/dragonfly-doe2/actions)
[![Coverage Status](https://coveralls.io/repos/github/ladybug-tools/dragonfly-doe2/badge.svg?branch=master)](https://coveralls.io/github/ladybug-tools/dragonfly-doe2)

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

# dragonfly-doe2

Dragonfly extension for energy modeling with the DOE-2 engine.

[DOE-2](https://www.doe2.com/) is a widely used and accepted freeware building energy analysis program that can predict the energy use and cost for all types of buildings.

## Installation

`pip install -U dragonfly-doe2`

## QuickStart

```console
import dragonfly_doe2
```

## [API Documentation](http://ladybug-tools.github.io/dragonfly-doe2/docs)

## Local Development

1. Clone this repo locally
```console
git clone git@github.com:ladybug-tools/dragonfly-doe2

# or

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

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

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



            

Raw data

            {
    "_id": null,
    "home_page": "https://github.com/ladybug-tools/dragonfly-doe2",
    "name": "dragonfly-doe2",
    "maintainer": "",
    "docs_url": null,
    "requires_python": "",
    "maintainer_email": "",
    "keywords": "",
    "author": "Ladybug Tools",
    "author_email": "info@ladybug.tools",
    "download_url": "https://files.pythonhosted.org/packages/36/6c/0b379ac031a4ba91c9bc9270157656fcaaa864023af6bdfdc292c9774cd4/dragonfly-doe2-0.11.3.tar.gz",
    "platform": null,
    "description": "![Dragonfly](https://www.ladybug.tools/assets/img/dragonfly.png)\n\n[![Build Status](https://github.com/ladybug-tools/dragonfly-doe2/workflows/CI/badge.svg)](https://github.com/ladybug-tools/dragonfly-doe2/actions)\n[![Coverage Status](https://coveralls.io/repos/github/ladybug-tools/dragonfly-doe2/badge.svg?branch=master)](https://coveralls.io/github/ladybug-tools/dragonfly-doe2)\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# dragonfly-doe2\n\nDragonfly extension for energy modeling with the DOE-2 engine.\n\n[DOE-2](https://www.doe2.com/) is a widely used and accepted freeware building energy analysis program that can predict the energy use and cost for all types of buildings.\n\n## Installation\n\n`pip install -U dragonfly-doe2`\n\n## QuickStart\n\n```console\nimport dragonfly_doe2\n```\n\n## [API Documentation](http://ladybug-tools.github.io/dragonfly-doe2/docs)\n\n## Local Development\n\n1. Clone this repo locally\n```console\ngit clone git@github.com:ladybug-tools/dragonfly-doe2\n\n# or\n\ngit clone https://github.com/ladybug-tools/dragonfly-doe2\n```\n2. Install dependencies:\n```\ncd dragonfly-doe2\npip install -r dev-requirements.txt\npip install -r requirements.txt\n```\n\n3. Run Tests:\n```console\npython -m pytest tests/\n```\n\n4. Generate Documentation:\n```console\nsphinx-apidoc -f -e -d 4 -o ./docs ./dragonfly_doe2\nsphinx-build -b html ./docs ./docs/_build/docs\n```\n\n\n",
    "bugtrack_url": null,
    "license": "AGPL-3.0",
    "summary": "Dragonfly extension for the DOE-2 energy simulation engine.",
    "version": "0.11.3",
    "split_keywords": [],
    "urls": [
        {
            "comment_text": "",
            "digests": {
                "md5": "18706ca74b188fa177a7f2173d341828",
                "sha256": "91d143a069491359e0e0067dba41a73c57aa17b56960d7089037d8d3010be981"
            },
            "downloads": -1,
            "filename": "dragonfly_doe2-0.11.3-py2.py3-none-any.whl",
            "has_sig": false,
            "md5_digest": "18706ca74b188fa177a7f2173d341828",
            "packagetype": "bdist_wheel",
            "python_version": "py2.py3",
            "requires_python": null,
            "size": 35128,
            "upload_time": "2022-10-28T23:55:43",
            "upload_time_iso_8601": "2022-10-28T23:55:43.144306Z",
            "url": "https://files.pythonhosted.org/packages/a6/71/a08ee36b9e8aacd61c3197ee036a1d1aa43da1348eb9ef03cc9757d8c732/dragonfly_doe2-0.11.3-py2.py3-none-any.whl",
            "yanked": false,
            "yanked_reason": null
        },
        {
            "comment_text": "",
            "digests": {
                "md5": "abd62d60ce93281779954c34e85f0e39",
                "sha256": "cfb763787b4f03ba2b6c2c3b83befee7c9fa3c5a75b850790e5bf66e05443786"
            },
            "downloads": -1,
            "filename": "dragonfly-doe2-0.11.3.tar.gz",
            "has_sig": false,
            "md5_digest": "abd62d60ce93281779954c34e85f0e39",
            "packagetype": "sdist",
            "python_version": "source",
            "requires_python": null,
            "size": 19023369,
            "upload_time": "2022-10-28T23:55:46",
            "upload_time_iso_8601": "2022-10-28T23:55:46.303702Z",
            "url": "https://files.pythonhosted.org/packages/36/6c/0b379ac031a4ba91c9bc9270157656fcaaa864023af6bdfdc292c9774cd4/dragonfly-doe2-0.11.3.tar.gz",
            "yanked": false,
            "yanked_reason": null
        }
    ],
    "upload_time": "2022-10-28 23:55:46",
    "github": true,
    "gitlab": false,
    "bitbucket": false,
    "github_user": "ladybug-tools",
    "github_project": "dragonfly-doe2",
    "travis_ci": false,
    "coveralls": false,
    "github_actions": true,
    "requirements": [
        {
            "name": "dragonfly-energy",
            "specs": [
                [
                    ">=",
                    "1.22.9"
                ]
            ]
        }
    ],
    "lcname": "dragonfly-doe2"
}