https://github.com/ladybug-tools/ladybug-display

🐞 :computer: Assigns basic display attributes to ladybug-geometry objects (color, line weight, line type, etc).
https://github.com/ladybug-tools/ladybug-display

Last synced: 9 months ago
JSON representation

🐞 :computer: Assigns basic display attributes to ladybug-geometry objects (color, line weight, line type, etc).

• Host: GitHub
• URL: https://github.com/ladybug-tools/ladybug-display
• Owner: ladybug-tools
• License: agpl-3.0
• Created: 2022-07-11T11:36:50.000Z (almost 4 years ago)
• Default Branch: master
• Last Pushed: 2025-09-02T21:44:38.000Z (9 months ago)
• Last Synced: 2025-09-02T23:22:46.264Z (9 months ago)
• Language: Python
• Homepage: https://www.ladybug.tools/ladybug-display/docs/
• Size: 2.31 MB
• Stars: 3
• Watchers: 4
• Forks: 2
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • Contributing: CONTRIBUTING.md
  • License: LICENSE
  • Code of conduct: CODE_OF_CONDUCT.md

Awesome Lists containing this project

README

          
[![Build Status](https://github.com/ladybug-tools/ladybug-display/workflows/CI/badge.svg)](https://github.com/ladybug-tools/ladybug-display/actions)

[![Python 3.7](https://img.shields.io/badge/python-3.7-blue.svg)](https://www.python.org/downloads/release/python-370/) [![Python 2.7](https://img.shields.io/badge/python-2.7-green.svg)](https://www.python.org/downloads/release/python-270/) [![IronPython](https://img.shields.io/badge/ironpython-2.7-red.svg)](https://github.com/IronLanguages/ironpython2/releases/tag/ipy-2.7.8/)

# ladybug-display

A library that assigns basic display attributes to ladybug-geometry objects

(color, line weight, line type, etc). It also extends several core Ladybug objects

with methods to translate them to a VisualzationSet (Sunpath, WindRose, etc.).

## Installation

To install the library use:

```console

pip install ladybug-display

```

## QuickStart

```python

import ladybug_display

```

## [API Documentation](http://ladybug-tools.github.io/ladybug-display/docs)

## Local Development

1. Clone this repo locally

```console

git clone git@github.com:ladybug-tools/ladybug-display

# or

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

```

2. Install dependencies:

```console

cd ladybug-display

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_display

sphinx-build -b html ./docs ./docs/_build/docs

```