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
Metadata
1 maintainer
Release files for ladybug-core 0.45.2
For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.
Source distribution (sdist)
| File | Size | Uploaded | Provenance | Actions |
|---|---|---|---|---|
| ladybug_core-0.45.2.tar.gz | 252.8 kB | Without provenance | Details for ladybug_core-0.45.2.tar.gz |
Built distribution (wheel)
| File | Interpreter | ABI | Platform | Actions Reset |
|---|---|---|---|---|
| ladybug_core-0.45.2-py3-none-any.whl | Python 3 | none | any | Details for ladybug_core-0.45.2-py3-none-any.whl |
Total release size: 535.5 kB
Release files / ladybug_core-0.45.2.tar.gz
| Download URL | ladybug_core-0.45.2.tar.gz |
|---|---|
| Size | 252.8 kB |
| Tags | Source |
|
SHA-256 checksum How to use checksums |
cf46f1634025fdd9f5f58c7eaadd075a71d4f98ff5632a8679b67ef0025d47e0
|
|
BLAKE2b-256 checksum How to use checksums |
b6aaa723b272856547f6dc36f177916a6d955922b78af0298e67bbadf6d37f40
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
| Uploaded via |
twine/6.1.0 CPython/3.12.16
|
Release files / ladybug_core-0.45.2-py3-none-any.whl
| Download URL | ladybug_core-0.45.2-py3-none-any.whl |
|---|---|
| Size | 282.6 kB |
| Tags | Python 3 |
|
SHA-256 checksum How to use checksums |
3c7ff1d87cbec827ad7ce89f17cb0a25a0cc894b2b683ea8d8b8867f5d9c5fee
|
|
BLAKE2b-256 checksum How to use checksums |
a04daa5026290db3312da27e49e8d8847dd82ff04a72e75be252b5cf9395aef8
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
| Uploaded via |
twine/6.1.0 CPython/3.12.16
|
Security for ladybug-core 0.45.2
Provenance
Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.
No provenance found
None of the files in this release were uploaded with provenance metadata.
A note on package security
PyPI is a repository for distributing packages, not a service for auditing them. While third-party security researchers and our staff do their best to detect and remove malicious packages, PyPI cannot guarantee the quality, security or suitability of any given package.
To learn more about protecting yourself from malicious actors, visit our package security documentation.
