Metadata-Version: 2.4
Name: urbanplot
Version: 0.1.4
Summary: Urban-scale climate visualization and ICON model plotting framework
Author-email: KIT / IMKTRO <imktro-climate-modelling@lists.kit.edu>
License: Apache-2.0
Project-URL: Documentation, https://evasuite-urbanplots-22deeb.gitlab-pages.dkrz.de
Project-URL: Repository, https://gitlab.dkrz.de/clm-community/public/evasuite-addons/evasuite_urbanplots
Project-URL: Homepage, https://gitlab.dkrz.de/clm-community/public/evasuite-addons/evasuite_urbanplots
Keywords: climate,ICON,visualization,geospatial,urban
Classifier: Programming Language :: Python :: 3.11
Classifier: License :: OSI Approved :: Apache Software License
Classifier: Operating System :: POSIX :: Linux
Classifier: Topic :: Scientific/Engineering :: Atmospheric Science
Requires-Python: >=3.10
Description-Content-Type: text/markdown
License-File: AUTHORS.TXT
Requires-Dist: numpy<2.3,>=1.26
Requires-Dist: xarray>=2024.1
Requires-Dist: Cartopy>=0.22
Requires-Dist: Flask>=3.0
Requires-Dist: scipy>=1.11
Requires-Dist: xclim>=0.45
Requires-Dist: osmnx>=2.1
Requires-Dist: imageio>=2.31
Requires-Dist: netCDF4>=1.6
Requires-Dist: h5netcdf>=1.3
Requires-Dist: h5py>=3.10
Requires-Dist: matplotlib>=3.10
Requires-Dist: pandas>=2.2
Requires-Dist: geopandas>=1.1
Requires-Dist: shapely>=2.1
Requires-Dist: pyproj>=3.7
Requires-Dist: cf_xarray>=0.10
Requires-Dist: dask>=2025.1
Requires-Dist: PyYAML>=6.0
Requires-Dist: Pint>=0.25
Dynamic: license-file

# UrbanPlot – Urban Climate Visualization and Evaluation Framework

![UrbanPlot Logo](DOCS/assets/LOGO_GitRepo.png)

* [**Documentation**](DOCS/index.md)
* [**Installation Guide**](DOCS/installation.md)
* [**Quick Start Guide**](DOCS/quick_start.md)
* [**Release Guide**](DOCS/release_guide.md)

---

## Introduction

**UrbanPlot** is a Python-based framework for visualization and evaluation of climate model simulations on urban and regional scales. It provides a standardized workflow for processing, harmonizing, comparing, and visualizing climate datasets from numerical models and observational products.

UrbanPlot combines automated scientific data processing with publication-quality cartographic visualization. The framework supports temporal, unit, coordinate, and grid harmonization workflows, allowing datasets with different structures and resolutions to be compared consistently. UrbanPlot is particularly designed for ICON-based climate simulations but can be extended to other xarray-compatible climate datasets.

For a comprehensive introduction and detailed user documentation, please consult the project documentation.

## Key Features

* **Climate Model Evaluation**

  * Compare climate simulations against observational and reference datasets

* **Automated Harmonization**

  * Temporal harmonization
  * Unit harmonization
  * Coordinate harmonization
  * Grid harmonization

* **Urban Climate Visualization**

  * Publication-quality maps
  * OpenStreetMap integration
  * ICON triangular grid support

* **Flexible Processing Modes**

  * Standalone visualization mode
  * Model-reference comparison mode
  * Time-series generation workflows

* **Scientific Python Ecosystem**

  * xarray
  * Cartopy
  * GeoPandas
  * OSMnx
  * NumPy

* **Configuration-Driven Design**

  * Reproducible workflows
  * User-defined variables
  * Flexible processing pipelines

## General Information

The UrbanPlot documentation provides detailed information on installation, configuration, data processing, examples, and developer workflows. Software installation and environment setup are described in the [Installation Guide](DOCS/installation.md). New users should begin with the [Quick Start Guide](DOCS/quick_start.md), which demonstrates the complete workflow from configuration generation to figure creation. Configuration options are documented in the [Configuration Guide](DOCS/configuration.md), including the main runtime configuration, ICON plotting configuration, and OpenStreetMap configuration.

The scientific processing workflow is described in the [Data Processing Guide](DOCS/data_processing.md), including temporal harmonization, unit harmonization, coordinate harmonization, and grid harmonization. Practical examples for temperature and precipitation analysis are provided in the [Examples](DOCS/examples.md) section.

Developers interested in extending UrbanPlot can consult the [API Reference](DOCS/api.md), the [Developer Guide](DOCS/developer_guide.md), and the [Release Guide](DOCS/release_guide.md). A complete overview of the available documentation is provided on the documentation [Home](DOCS/index.md) page.

## Getting Help

If you cannot find the answer in the documentation, please open an issue in the project repository.

## Authors
See [AUTHORS.TXT](AUTHORS.TXT) for a complete list of contributors.

## Contributing
Contributions are welcome through the CLM-Community development workflow. Please consult the contribution guidelines and coding standards before submitting changes.


## License
Copyright (C) 2024-2026, Karlsruhe Institute of Technology

UrbanPlot is licensed under the **Apache-2.0**.
See [LICENSES/Apache-2.0.txt](LICENSES/Apache-2.0.txt) for the full license text.

Bundled third-party components may be distributed under different licenses.
All applicable license texts are collected in the [LICENSES/](LICENSES/) directory:

| License | Components |
|---------|-----------|
| Apache-2.0 | additional third-party components |

SPDX-License-Identifier: Apache-2.0

