Metadata-Version: 2.1
Name: supy-tree-v8
Version: 8.1.1
Summary: Tree-canopy-optimised SUEWS model for urban radiation, energy balance and near-surface climate
Author-Email: Dr Ting Sun <ting.sun@ucl.ac.uk>
License: GPL-V3.0
Classifier: Programming Language :: Python :: 3 :: Only
Classifier: Programming Language :: Python :: 3.12
Classifier: Programming Language :: Python :: 3.13
Classifier: Programming Language :: Python :: 3.14
Classifier: Intended Audience :: Science/Research
Classifier: Intended Audience :: Education
Classifier: Operating System :: MacOS :: MacOS X
Classifier: Operating System :: Microsoft :: Windows
Classifier: Operating System :: POSIX :: Linux
Project-URL: Homepage, https://github.com/CynthiaGuo0423/SUEWS_tree
Project-URL: Repository, https://github.com/CynthiaGuo0423/SUEWS_tree
Project-URL: Issues, https://github.com/CynthiaGuo0423/SUEWS_tree/issues
Requires-Python: >=3.12
Requires-Dist: pandas<3; python_version < "3.13" and platform_system == "Linux"
Requires-Dist: pandas; python_version >= "3.13" or platform_system != "Linux"
Requires-Dist: numpy>=1.22
Requires-Dist: scipy<1.15; python_version < "3.13" and platform_system == "Linux"
Requires-Dist: scipy; python_version >= "3.13" or platform_system != "Linux"
Requires-Dist: pydantic>=2.12
Requires-Dist: pyyaml
Requires-Dist: f90nml
Requires-Dist: matplotlib
Requires-Dist: seaborn
Requires-Dist: chardet
Requires-Dist: click
Requires-Dist: pyarrow<21,>=20; python_version < "3.14" and platform_system == "Linux"
Requires-Dist: pyarrow>=20; python_version < "3.14" and platform_system != "Linux"
Requires-Dist: pyarrow>=22; python_version >= "3.14"
Requires-Dist: atmosp
Requires-Dist: scikit-learn
Requires-Dist: lmfit
Requires-Dist: cdsapi
Requires-Dist: tzfpy>=1.0.0
Requires-Dist: pytz
Requires-Dist: jsonschema
Requires-Dist: rich
Requires-Dist: packaging
Provides-Extra: tmy
Requires-Dist: pvlib; extra == "tmy"
Requires-Dist: metpy; extra == "tmy"
Provides-Extra: dev
Requires-Dist: pytest; extra == "dev"
Requires-Dist: pytest-cov; extra == "dev"
Requires-Dist: pytest-xdist; extra == "dev"
Requires-Dist: ruff; extra == "dev"
Requires-Dist: fprettify; extra == "dev"
Requires-Dist: ipykernel; extra == "dev"
Provides-Extra: docs
Requires-Dist: sphinx<9,>=7; extra == "docs"
Requires-Dist: sphinx-autobuild; extra == "docs"
Requires-Dist: sphinx-book-theme; extra == "docs"
Requires-Dist: pybtex; extra == "docs"
Requires-Dist: sphinxcontrib-bibtex<3,>=2.6; extra == "docs"
Requires-Dist: sphinx-design>=0.7.0; extra == "docs"
Requires-Dist: sphinx-last-updated-by-git; extra == "docs"
Requires-Dist: sphinx-click; extra == "docs"
Requires-Dist: sphinx-gallery>=0.16.0; extra == "docs"
Requires-Dist: docutils<0.22,>=0.21; extra == "docs"
Requires-Dist: jinja2>=3.0; extra == "docs"
Description-Content-Type: text/markdown

# SuPy Tree V8

`supy-tree-v8` is an independently packaged research version of SUEWS focused
on improving the representation of urban tree-canopy processes. Compared with
the unmodified SUEWS model, it refines how tree canopies affect radiative
transfer, sky-view obstruction and aerodynamic drag, exposes the associated
tree controls as configurable inputs, and propagates these effects through the
surface energy balance to near-surface outputs such as 2 m air temperature
(`T2`) and 10 m wind speed (`U10`). The package retains the standard SuPy
Python interface (`import supy`) and is intended for reproducible studies of
urban-tree shading, cooling and ventilation effects.

`supy-tree-v8` 是一个针对城市树木冠层过程进行优化的 SUEWS 独立研究版本。
与原版 SUEWS 相比，本模型重点改进树冠对辐射传输、天空可视程度和空气动力
阻力的影响，将相关树木参数作为可配置输入，并使这些影响通过地表能量平衡
传递到 2 米气温（`T2`）、10 米风速（`U10`）等近地面输出。该软件包保留
SuPy 的 Python 使用接口（`import supy`），主要用于研究城市树木的遮阴、
降温及通风效应。

## Installation

Install the distribution in a dedicated Python environment:

```bash
python -m pip install supy-tree-v8
```

The distribution name is `supy-tree-v8`, while the Python import name remains
`supy` for compatibility with existing SuPy scripts. Do not install it in the
same environment as the upstream `supy` distribution.

```python
from supy import SUEWSSimulation
```

## Project

Source code and release notes are available from
[`CynthiaGuo0423/SUEWS_tree`](https://github.com/CynthiaGuo0423/SUEWS_tree).

This package is a research fork of SUEWS. For the upstream model and official
documentation, visit [`UMEP-dev/SUEWS`](https://github.com/UMEP-dev/SUEWS) and
[`docs.suews.io`](https://docs.suews.io).

## Licence and citation

The model is distributed under the repository's open-source licence. Users
should cite the original SUEWS publications and clearly identify the
`supy-tree-v8` version used in their research.
