Skip to main content

Python library to load, analyze and modify EnergyPlus Weather files (epw).

Project description

Ladybug

Build Status Coverage Status

Python 3.7 Python 2.7 IronPython

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

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

# or

git clone https://github.com/ladybug-tools/ladybug.git
  1. Install dependencies:
cd ladybug
pip install -r dev-requirements.txt
pip install -r requirements.txt
  1. Run Tests:
python -m pytest ./tests
  1. 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.

Project details


Release history Release notifications | RSS feed

Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

ladybug_core-0.44.19.tar.gz (242.3 kB view details)

Uploaded Source

Built Distribution

ladybug_core-0.44.19-py2.py3-none-any.whl (272.3 kB view details)

Uploaded Python 2Python 3

File details

Details for the file ladybug_core-0.44.19.tar.gz.

File metadata

  • Download URL: ladybug_core-0.44.19.tar.gz
  • Upload date:
  • Size: 242.3 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/5.1.1 CPython/3.12.11

File hashes

Hashes for ladybug_core-0.44.19.tar.gz
Algorithm Hash digest
SHA256 98d02fdfbc93db4d4397ea3e2c0ea39c65c5a506e04bc081ce81a7633f08a8a5
MD5 b4632e0f8b381b2e143bacdebe5e5bdd
BLAKE2b-256 571505a5c63bc00a0f30618f1e17650030e0d2d4a925ff3add14479e7cd7d4b8

See more details on using hashes here.

File details

Details for the file ladybug_core-0.44.19-py2.py3-none-any.whl.

File metadata

File hashes

Hashes for ladybug_core-0.44.19-py2.py3-none-any.whl
Algorithm Hash digest
SHA256 afce3598dc0bef364ad12b7173114d0a4aec89a420402bf21add2c286ba5716a
MD5 0fd29ab8d9e50b6ce67fe810e0fd211b
BLAKE2b-256 efa13a7134edaae0643c07fb1539de2862ec6d01ab7de098c2c593a6436db613

See more details on using hashes here.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page