Metadata-Version: 2.4
Name: umep-solweig
Version: 2026.0.1
Summary: SOLWEIG algorithm implementation for urban thermal and radiation simulation
Author-email: UMEP Development Team <umep@geo.su.se>
License: GPL-3.0-only
Project-URL: Documentation, https://umep-docs.readthedocs.io/
Project-URL: Repository, https://github.com/UMEP-dev/umep-solweig
Keywords: urban climate,thermal comfort,solar radiation,SOLWEIG,urban geometry,meteorology
Classifier: Development Status :: 5 - Production/Stable
Classifier: Intended Audience :: Science/Research
Classifier: License :: OSI Approved :: GNU General Public License v3 (GPLv3)
Classifier: Operating System :: OS Independent
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3.8
Classifier: Programming Language :: Python :: 3.9
Classifier: Programming Language :: Python :: 3.10
Classifier: Programming Language :: Python :: 3.11
Classifier: Programming Language :: Python :: 3.12
Classifier: Topic :: Scientific/Engineering :: Atmospheric Science
Classifier: Topic :: Scientific/Engineering :: Physics
Requires-Python: >=3.8
Description-Content-Type: text/markdown
License-File: LICENSE
Requires-Dist: numpy>=1.21.0
Requires-Dist: scipy>=1.7.0
Requires-Dist: netCDF4>=1.5.0
Requires-Dist: pandas>=3.0
Requires-Dist: scipy>=1.17.0
Requires-Dist: gdal>=3.10.1
Provides-Extra: torch
Requires-Dist: torch>=1.10.0; extra == "torch"
Provides-Extra: gpu
Requires-Dist: torch>=1.10.0; extra == "gpu"
Requires-Dist: cuda-toolkit>=11.2; extra == "gpu"
Provides-Extra: dev
Requires-Dist: pytest>=7.0; extra == "dev"
Requires-Dist: pytest-cov>=4.0; extra == "dev"
Requires-Dist: black>=23.0; extra == "dev"
Requires-Dist: flake8>=5.0; extra == "dev"
Requires-Dist: mypy>=1.0; extra == "dev"
Requires-Dist: isort>=5.12; extra == "dev"
Provides-Extra: docs
Requires-Dist: sphinx>=5.0; extra == "docs"
Requires-Dist: sphinx-rtd-theme>=1.1; extra == "docs"
Dynamic: license-file

# umep-solweig

A python package to run the SOLWEIG algorithm.

## How to install

To install the package, run pip install umep-solweig

If you want some execution examples, look at the files inside the tests folder of the github.

## how to build the package from the source code :

### Setup

To build you package you need to install the build pip package inside you venv.

```bash
pip install build
```

### Building

The to build the plugin you can run :

```bash
python -m build
```

### How to install the version you built

Run inside you terminal from the project's root :

```bash
pip install ./dist/umep_solweig-{version_year}.{version}-py{python_major_version}-none-any.whl
```

If you already have the package installed, do not forger to uninstall the current version before installing the new one with :

```bash
pip uninstall umep-solweig -y
```

## Development

If you're working on the code, please do not forger to run the tests after you've build and installed your local version of the package. **This is a realy important step, do not avoid it**. From the root run :

```bash
python -m pytest -q ./tests/
```

Ps: a new algorithm added or a new feature added means a new test added. If you've change the way an algorithm is working, please update the tests.
