ladybug-tools / ladybug-tools/ladybug

Add methods to make human-readable conditional statements

Open
#301 2 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

enhancement
Dominant language
Python
Stars
228
Forks
62
Avg merge
2h 19m
Merged PRs (30d)
3

Description

For many of the climate graphics, we display information like the data collection metadata and the analysis period. But we currently don't output any text to indicate the application of conditional statements.

Because this text is something that many weather visualizations are likely to use, we should add a staticmethod to the BaseCollection class that can build these text statements. Instead of using the full name of the data type, we can use the abbreviation property to keep the statements short and easily readable.

Contributor guide

Open the contributing guide

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Research direction

Start with the BaseCollection class in ladybug/_datacollectionbase.py and inspect the abbreviation property in ladybug/datatype/base.py. Determine the conditional statements needed by the weather visualizations and how the existing collection and data-type APIs represent them. Done means the BaseCollection API can produce concise, human-readable text for applied conditional statements, with behavior covered by appropriate tests.

Written by the indexing model from the issue text.

Assessment

Tech stack
python
Domain
data
Issue type
Feature
Difficulty
3/5
Estimated time
1-2 days
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
45/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.