ladybug-tools / ladybug

🐞 Core ladybug library for weather data analysis and visualization
https://www.ladybug.tools/ladybug/docs/
GNU Affero General Public License v3.0
191 stars 54 forks source link

Add methods to make human-readable conditional statements #301

Open chriswmackey opened 4 years ago

chriswmackey commented 4 years ago

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.

razinc commented 3 years ago

Hello. I'm interested to try this but I need clarification. Where can I get the information to be returned by the staticmethod?

chriswmackey commented 3 years ago

Hi @razinc . Sorry for such a late response. We are basically looking to convert the text that gets input to filter_collections_by_statement method and turn it into something that has the abbreviation of the data types in it.