ladybug-core 0.44.42

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

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 [e-mail]:ladybug-tools/ladybug.git

# or

git clone https://github.com/ladybug-tools/ladybug.git

2. Install dependencies:

cd ladybug
pip install -r dev-requirements.txt
pip install -r requirements.txt

3. Run Tests:

python -m pytest ./tests

4. 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.