[](https://github.com/ladybug-tools/ladybug/actions)
[](https://coveralls.io/github/ladybug-tools/ladybug)
[](https://www.python.org/downloads/release/python-370/) [](https://www.python.org/downloads/release/python-270/) [](https://github.com/IronLanguages/ironpython2/releases/tag/ipy-2.7.8/)
# ladybug
Ladybug is a Python library to analyze, modify, and visualize EnergyPlus Weather files (epw). You can download epw files from [EPWMap](http://www.ladybug.tools/epwmap/).
This repository is the core library that is the base for the Ladybug Grasshopper Plugin. For plugin-specific questions and comments refer to [ladybug-grasshopper](https://github.com/ladybug-tools/ladybug-grasshopper).
## Note
For the Legacy Ladybug Grasshopper Plugin see [this repository](https://github.com/ladybug-tools/ladybug-legacy).
## [API Documentation](https://www.ladybug.tools/ladybug/docs/)
## Installation
To install the library use:
`pip install ladybug-core`
To check if Honeybee command line interface is installed correctly use `ladybug viz` and you
should get a `viiiiiiiiiiiiizzzzzzzzz!` back in response!
## Usage
```python
# load epw weather data
from ladybug.epw import EPW
epw_data = EPW('path_to_epw_file')
dry_bulb_temp = epw_data.dry_bulb_temperature
# Get altitude and longitude
from ladybug.location import Location
from ladybug.sunpath import Sunpath
# Create location. You can also extract location data from an epw file.
sydney = Location('Sydney', 'AUS', latitude=-33.87, longitude=151.22, time_zone=10)
# Initiate sunpath
sp = Sunpath.from_location(sydney)
sun = sp.calculate_sun(month=11, day=15, hour=11.0)
print('altitude: {}, azimuth: {}'.format(sun.altitude, sun.azimuth))
>>> altitude: 72.26, azimuth: 32.37
```
## Local Development
1. Clone this repo locally
```console
git clone git@github.com:ladybug-tools/ladybug.git
# or
git clone https://github.com/ladybug-tools/ladybug.git
```
2. Install dependencies:
```console
cd ladybug
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 ./ladybug
sphinx-build -b html ./docs ./docs/_build/docs
```
### Derivative Work
Ladybug is a derivative work of the following software projects:
* [PVLib-python](https://github.com/pvlib/pvlib-python) for solar irradiance calculations. Available under BSD 3-clause.
* [PsychroLib](https://github.com/psychrometrics/psychrolib) for psychrometric calculations. Available under MIT License.
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",
"name": "ladybug-core",
"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/b9/8f/c1863e2e52400271c5d80a33c6b71236d55fd067f25e8f2a22bc87cf0f27/ladybug_core-0.43.14.tar.gz",
"platform": null,
"description": "\n\n\n[](https://github.com/ladybug-tools/ladybug/actions)\n[](https://coveralls.io/github/ladybug-tools/ladybug)\n\n[](https://www.python.org/downloads/release/python-370/) [](https://www.python.org/downloads/release/python-270/) [](https://github.com/IronLanguages/ironpython2/releases/tag/ipy-2.7.8/)\n\n# ladybug\n\nLadybug is a Python library to analyze, modify, and visualize EnergyPlus Weather files (epw). You can download epw files from [EPWMap](http://www.ladybug.tools/epwmap/).\n\nThis repository is the core library that is the base for the Ladybug Grasshopper Plugin. For plugin-specific questions and comments refer to [ladybug-grasshopper](https://github.com/ladybug-tools/ladybug-grasshopper).\n\n## Note\n\nFor the Legacy Ladybug Grasshopper Plugin see [this repository](https://github.com/ladybug-tools/ladybug-legacy).\n\n## [API Documentation](https://www.ladybug.tools/ladybug/docs/)\n\n## Installation\n\nTo install the library use:\n\n`pip install ladybug-core`\n\nTo check if Honeybee command line interface is installed correctly use `ladybug viz` and you\nshould get a `viiiiiiiiiiiiizzzzzzzzz!` back in response!\n\n## Usage\n\n```python\n# load epw weather data\nfrom ladybug.epw import EPW\nepw_data = EPW('path_to_epw_file')\ndry_bulb_temp = epw_data.dry_bulb_temperature\n\n# Get altitude and longitude\nfrom ladybug.location import Location\nfrom ladybug.sunpath import Sunpath\n\n# Create location. You can also extract location data from an epw file.\nsydney = Location('Sydney', 'AUS', latitude=-33.87, longitude=151.22, time_zone=10)\n\n# Initiate sunpath\nsp = Sunpath.from_location(sydney)\nsun = sp.calculate_sun(month=11, day=15, hour=11.0)\n\nprint('altitude: {}, azimuth: {}'.format(sun.altitude, sun.azimuth))\n>>> altitude: 72.26, azimuth: 32.37\n```\n\n## Local Development\n1. Clone this repo locally\n```console\ngit clone git@github.com:ladybug-tools/ladybug.git\n\n# or\n\ngit clone https://github.com/ladybug-tools/ladybug.git\n```\n2. Install dependencies:\n```console\ncd ladybug\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 ./ladybug\nsphinx-build -b html ./docs ./docs/_build/docs\n```\n\n### Derivative Work\n\nLadybug is a derivative work of the following software projects:\n\n* [PVLib-python](https://github.com/pvlib/pvlib-python) for solar irradiance calculations. Available under BSD 3-clause.\n* [PsychroLib](https://github.com/psychrometrics/psychrolib) for psychrometric calculations. Available under MIT License.\n\nApplicable copyright notices for these works can be found within the relevant .py files.\n",
"bugtrack_url": null,
"license": "AGPL-3.0",
"summary": "Python library to load, analyze and modify EnergyPlus Weather files (epw).",
"version": "0.43.14",
"project_urls": {
"Homepage": "https://github.com/ladybug-tools/ladybug"
},
"split_keywords": [],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "94af5a27cff3c93732b312f22bab76eab539cb6f0fcb302c5213357bec6308b6",
"md5": "6cdab470071e154986e26948ad8f76cc",
"sha256": "d565b40b282b11d47fad62c545badd8ad9929503d3bba24438e50840bbb7aefa"
},
"downloads": -1,
"filename": "ladybug_core-0.43.14-py2.py3-none-any.whl",
"has_sig": false,
"md5_digest": "6cdab470071e154986e26948ad8f76cc",
"packagetype": "bdist_wheel",
"python_version": "py2.py3",
"requires_python": null,
"size": 266911,
"upload_time": "2024-10-31T21:05:56",
"upload_time_iso_8601": "2024-10-31T21:05:56.113931Z",
"url": "https://files.pythonhosted.org/packages/94/af/5a27cff3c93732b312f22bab76eab539cb6f0fcb302c5213357bec6308b6/ladybug_core-0.43.14-py2.py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "b98fc1863e2e52400271c5d80a33c6b71236d55fd067f25e8f2a22bc87cf0f27",
"md5": "77f3b1b7e28d111c0e83fbebbcdd2f39",
"sha256": "23805def74b0e478b036bec1044e62e39d75d7894975839d35b1ea0240f434b0"
},
"downloads": -1,
"filename": "ladybug_core-0.43.14.tar.gz",
"has_sig": false,
"md5_digest": "77f3b1b7e28d111c0e83fbebbcdd2f39",
"packagetype": "sdist",
"python_version": "source",
"requires_python": null,
"size": 239864,
"upload_time": "2024-10-31T21:05:57",
"upload_time_iso_8601": "2024-10-31T21:05:57.542291Z",
"url": "https://files.pythonhosted.org/packages/b9/8f/c1863e2e52400271c5d80a33c6b71236d55fd067f25e8f2a22bc87cf0f27/ladybug_core-0.43.14.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-10-31 21:05:57",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "ladybug-tools",
"github_project": "ladybug",
"travis_ci": false,
"coveralls": true,
"github_actions": true,
"requirements": [],
"lcname": "ladybug-core"
}
JSON
