# Developer Guide

This guide is intended for developers who want to understand the architecture of SOLWEIG-GPU and contribute to its development.

## Reporting issues and getting support

- **Bug reports and feature requests**: Please open an [issue on GitHub](https://github.com/nvnsudharsan/SOLWEIG-GPU/issues). Use the [bug report](https://github.com/nvnsudharsan/SOLWEIG-GPU/issues/new?template=bug_report.md) or [feature request](https://github.com/nvnsudharsan/SOLWEIG-GPU/issues/new?template=feature_request.md) templates when applicable so we can help you faster.
- **Questions and discussion**: For usage questions, ideas, or general discussion, you can open a [GitHub Discussion](https://github.com/nvnsudharsan/SOLWEIG-GPU/discussions) or use the repository’s issue tracker with the “Question” label.

## Architecture Overview

SOLWEIG-GPU is a modular package that separates the different stages of the thermal comfort modeling process. The main components are:

-   **Data Preprocessing**: Handles the validation, tiling, and extraction of input data.
-   **Geometry Processing**: Calculates wall heights and aspects from the input rasters.
-   **Core SOLWEIG Model**: The main radiation and thermal comfort calculation engine, accelerated with PyTorch.
-   **Interfaces**: Provides both a command-line interface (CLI) and a graphical user interface (GUI) for user interaction.

## Module Interactions

The `solweig_gpu.py` module acts as the main orchestrator, calling the other modules in the correct sequence. The `utci_process.py` module is the core of the computation, bringing together the various components to calculate the final UTCI values.

## Contributing to SOLWEIG-GPU

We welcome contributions to the SOLWEIG-GPU project. To contribute, please follow these steps:

1.  **Fork the Repository**: Create your own fork of the [SOLWEIG-GPU repository](https://github.com/nvnsudharsan/SOLWEIG-GPU) on GitHub.
2.  **Create a Feature Branch**: Create a new branch for your feature or bug fix.
3.  **Set up for development**: Clone your fork and install with the test extra (test dependencies are in `setup.py`): `pip install -e ".[test]"`. See [Installation](docs/installation.md).
4.  **Run the test suite** before submitting: `pytest tests/ -q`. See the [Testing Guide](docs/testing.md).
5.  **Commit Your Changes**: Make your changes and commit them with clear and concise commit messages.
6.  **Push to Your Branch**: Push your changes to your forked repository.
7.  **Create a Pull Request**: Open a pull request from your branch to the `main` branch of the original repository.

Please ensure that your pull requests are small and focused on a single feature or bug fix. This makes it easier to review and merge your contributions.