ladybug
Ladybug is a Python library to analyze, modify, and visualize EnergyPlus Weather files (epw). You can download epw files from 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.
Note
For the Legacy Ladybug Grasshopper Plugin see this repository.
API Documentation
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
# 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
- Clone this repo locally
git clone git@github.com:ladybug-tools/ladybug.git
# or
git clone https://github.com/ladybug-tools/ladybug.git
- Install dependencies:
cd ladybug
pip install -r dev-requirements.txt
pip install -r requirements.txt
- Run Tests:
python -m pytest ./tests
- Generate Documentation:
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 for solar irradiance calculations. Available under BSD 3-clause.
- PsychroLib for psychrometric calculations. Available under MIT License.
Applicable copyright notices for these works can be found within the relevant .py files.
1 maintainer
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
Built Distribution
Filter files by name, interpreter, ABI, and platform.
If you're not sure about the file name format, learn more about wheel file names.
Copy a direct link to the current filters
File details
Details for the file ladybug_core-0.44.54.tar.gz.
File metadata
- Download URL: ladybug_core-0.44.54.tar.gz
- Upload date:
- Size: 246.3 kB
- Tags: Source
- Uploaded using Trusted Publishing? No
- Uploaded via:
twine/6.1.0 CPython/3.12.13
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 |
791164d6fa4242a8f0da1039300a148022091488795d675f2d0394a59e7f002e
|
|
| MD5 |
f004fa38d3104d390deb361817d62fc6
|
|
| BLAKE2b-256 |
064abb598417bfd8080f73a32ab02f0e56033627d2aee7a368fcb030050319ec
|
File details
Details for the file ladybug_core-0.44.54-py3-none-any.whl.
File metadata
- Download URL: ladybug_core-0.44.54-py3-none-any.whl
- Upload date:
- Size: 275.1 kB
- Tags: Python 3
- Uploaded using Trusted Publishing? No
- Uploaded via:
twine/6.1.0 CPython/3.12.13
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 |
58ce70014cd295ae9069a8c442871370e598d34f33ee59a6f79dfa39d9537e0f
|
|
| MD5 |
3bb3755ff7085f8a50e6a57d3b4c714c
|
|
| BLAKE2b-256 |
a259736be04e4ca88e87dffbb84e69123b6c18cf4e27e7057699f08e5d729412
|
