ladybug-comfort


Nameladybug-comfort JSON
Version 0.18.18 PyPI version JSON
download
home_pagehttps://github.com/ladybug-tools/ladybug-comfort
SummaryLadybug comfort is a Python library that adds thermal comfort functionalities to Ladybug.
upload_time2024-04-20 00:23:17
maintainerNone
docs_urlNone
authorLadybug Tools
requires_pythonNone
licenseAGPL-3.0
keywords
VCS
bugtrack_url
requirements ladybug-core
Travis-CI No Travis.
coveralls test coverage No coveralls.
            
![Ladybug](http://www.ladybug.tools/assets/img/ladybug.png)

[![Build Status](https://travis-ci.com/ladybug-tools/ladybug.svg?branch=master)](https://travis-ci.com/ladybug-tools/ladybug-comfort)
[![Coverage Status](https://coveralls.io/repos/github/ladybug-tools/ladybug-comfort/badge.svg)](https://coveralls.io/github/ladybug-tools/ladybug-comfort)

[![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/)

# ladybug-comfort

Ladybug-comfort is a Python library that adds thermal comfort functionalities to
[ladybug-core](https://github.com/ladybug-tools/ladybug/).

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

## Installation

`pip install ladybug-comfort`

## Usage

```python
"""Get the percentage of time outdoor conditions are comfortable with/without sun + wind"""
from ladybug.epw import EPW
from ladybug_comfort.collection.utci import UTCI

epw_file_path = './tests/epw/chicago.epw'
epw = EPW(epw_file_path)
utci_obj_exposed = UTCI.from_epw(epw, include_wind=True, include_sun=True)
utci_obj_protected = UTCI.from_epw(epw, include_wind=False, include_sun=False)

print(utci_obj_exposed.percent_neutral)  # comfortable percent of time with sun + wind
print(utci_obj_protected.percent_neutral)  # comfortable percent of time without sun + wind
```

### derivative work

Ladybug-comfort is a derivative work of the following software projects:

* [CBE Comfort Tool](https://github.com/CenterForTheBuiltEnvironment/comfort_tool) for indoor thermal comfort calculations.  Available under GPL.
* [UTCI Fortran Code](http://www.utci.org/utci_doku.php) for outdoor thermal comfort calculations.  Available under MIT.

Applicable copyright notices for these works can be found within the relevant .py files.

            

Raw data

            {
    "_id": null,
    "home_page": "https://github.com/ladybug-tools/ladybug-comfort",
    "name": "ladybug-comfort",
    "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/d8/c1/d8b8819615301c8ef9ffd7e2ee184a84f47e7a3ed9913329417263af014d/ladybug-comfort-0.18.18.tar.gz",
    "platform": null,
    "description": "\n![Ladybug](http://www.ladybug.tools/assets/img/ladybug.png)\n\n[![Build Status](https://travis-ci.com/ladybug-tools/ladybug.svg?branch=master)](https://travis-ci.com/ladybug-tools/ladybug-comfort)\n[![Coverage Status](https://coveralls.io/repos/github/ladybug-tools/ladybug-comfort/badge.svg)](https://coveralls.io/github/ladybug-tools/ladybug-comfort)\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# ladybug-comfort\n\nLadybug-comfort is a Python library that adds thermal comfort functionalities to\n[ladybug-core](https://github.com/ladybug-tools/ladybug/).\n\n## [API Documentation](https://www.ladybug.tools/ladybug-comfort/docs/)\n\n## Installation\n\n`pip install ladybug-comfort`\n\n## Usage\n\n```python\n\"\"\"Get the percentage of time outdoor conditions are comfortable with/without sun + wind\"\"\"\nfrom ladybug.epw import EPW\nfrom ladybug_comfort.collection.utci import UTCI\n\nepw_file_path = './tests/epw/chicago.epw'\nepw = EPW(epw_file_path)\nutci_obj_exposed = UTCI.from_epw(epw, include_wind=True, include_sun=True)\nutci_obj_protected = UTCI.from_epw(epw, include_wind=False, include_sun=False)\n\nprint(utci_obj_exposed.percent_neutral)  # comfortable percent of time with sun + wind\nprint(utci_obj_protected.percent_neutral)  # comfortable percent of time without sun + wind\n```\n\n### derivative work\n\nLadybug-comfort is a derivative work of the following software projects:\n\n* [CBE Comfort Tool](https://github.com/CenterForTheBuiltEnvironment/comfort_tool) for indoor thermal comfort calculations.  Available under GPL.\n* [UTCI Fortran Code](http://www.utci.org/utci_doku.php) for outdoor thermal comfort calculations.  Available under MIT.\n\nApplicable copyright notices for these works can be found within the relevant .py files.\n",
    "bugtrack_url": null,
    "license": "AGPL-3.0",
    "summary": "Ladybug comfort is a Python library that adds thermal comfort functionalities to Ladybug.",
    "version": "0.18.18",
    "project_urls": {
        "Homepage": "https://github.com/ladybug-tools/ladybug-comfort"
    },
    "split_keywords": [],
    "urls": [
        {
            "comment_text": "",
            "digests": {
                "blake2b_256": "278ebb42b4c4dd4378c01e36403e61d575c069e14ad8491138abd8d3fb7b2ee4",
                "md5": "38ed744c43f18a0a7ae9bce6bde22b23",
                "sha256": "a6370a8121583ad369bdaf2af16442be674048409f1338855aa13cb4aa05e48d"
            },
            "downloads": -1,
            "filename": "ladybug_comfort-0.18.18-py2.py3-none-any.whl",
            "has_sig": false,
            "md5_digest": "38ed744c43f18a0a7ae9bce6bde22b23",
            "packagetype": "bdist_wheel",
            "python_version": "py2.py3",
            "requires_python": null,
            "size": 169444,
            "upload_time": "2024-04-20T00:23:13",
            "upload_time_iso_8601": "2024-04-20T00:23:13.849524Z",
            "url": "https://files.pythonhosted.org/packages/27/8e/bb42b4c4dd4378c01e36403e61d575c069e14ad8491138abd8d3fb7b2ee4/ladybug_comfort-0.18.18-py2.py3-none-any.whl",
            "yanked": false,
            "yanked_reason": null
        },
        {
            "comment_text": "",
            "digests": {
                "blake2b_256": "d8c1d8b8819615301c8ef9ffd7e2ee184a84f47e7a3ed9913329417263af014d",
                "md5": "90038436d4df39c499189d5ba199432e",
                "sha256": "b9395d766c20bf41673eceb8bdc86d4f86304acb13217ef1ca4e4eebb4612993"
            },
            "downloads": -1,
            "filename": "ladybug-comfort-0.18.18.tar.gz",
            "has_sig": false,
            "md5_digest": "90038436d4df39c499189d5ba199432e",
            "packagetype": "sdist",
            "python_version": "source",
            "requires_python": null,
            "size": 142236,
            "upload_time": "2024-04-20T00:23:17",
            "upload_time_iso_8601": "2024-04-20T00:23:17.246908Z",
            "url": "https://files.pythonhosted.org/packages/d8/c1/d8b8819615301c8ef9ffd7e2ee184a84f47e7a3ed9913329417263af014d/ladybug-comfort-0.18.18.tar.gz",
            "yanked": false,
            "yanked_reason": null
        }
    ],
    "upload_time": "2024-04-20 00:23:17",
    "github": true,
    "gitlab": false,
    "bitbucket": false,
    "codeberg": false,
    "github_user": "ladybug-tools",
    "github_project": "ladybug-comfort",
    "travis_ci": false,
    "coveralls": false,
    "github_actions": true,
    "requirements": [
        {
            "name": "ladybug-core",
            "specs": [
                [
                    "==",
                    "0.42.24"
                ]
            ]
        }
    ],
    "tox": true,
    "lcname": "ladybug-comfort"
}
        
Elapsed time: 0.26170s