Metadata-Version: 2.4
Name: citysketch
Version: 1.0.0rc5
Summary: A visual building editor with interactive building placement, basemap overlays, and real-time 3D height editing.
Author-email: Clemens Drüe <druee@uni-trier.de>
License: EUPL-1.2
Project-URL: Documentation, https://uwm.gitlab-pages.uni-trier.de/austal/citysketch/
Project-URL: Repository, https://github.com/cdruee/citysketch
Keywords: cityjson,gis,building-modeling,urban-planning,3d-visualization
Classifier: Development Status :: 4 - Beta
Classifier: Environment :: X11 Applications :: GTK
Classifier: Environment :: MacOS X
Classifier: Environment :: Win32 (MS Windows)
Classifier: Intended Audience :: Science/Research
Classifier: Intended Audience :: End Users/Desktop
Classifier: License :: OSI Approved :: European Union Public Licence 1.2 (EUPL 1.2)
Classifier: Operating System :: OS Independent
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3.7
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: Programming Language :: Python :: 3.13
Classifier: Topic :: Scientific/Engineering :: GIS
Classifier: Topic :: Scientific/Engineering :: Visualization
Classifier: Topic :: Multimedia :: Graphics :: 3D Modeling
Requires-Python: >=3.7
Description-Content-Type: text/markdown
License-File: LICENSE.txt
Requires-Dist: wxpython>=4.0.0
Requires-Dist: numpy>=1.16.0
Provides-Extra: geotiff
Requires-Dist: rasterio>=1.0.0; extra == "geotiff"
Requires-Dist: scipy>=1.0.0; extra == "geotiff"
Provides-Extra: opengl
Requires-Dist: PyOpenGL>=3.1.0; extra == "opengl"
Requires-Dist: PyOpenGL_accelerate>=3.1.0; extra == "opengl"
Provides-Extra: docs
Requires-Dist: sphinx<7.0.0,>=5.0.0; extra == "docs"
Requires-Dist: sphinx-rtd-theme>=1.2.0; extra == "docs"
Provides-Extra: dev
Requires-Dist: pytest; extra == "dev"
Provides-Extra: full
Requires-Dist: citysketch[geotiff,opengl]; extra == "full"
Provides-Extra: all
Requires-Dist: citysketch[dev,docs,geotiff,opengl]; extra == "all"
Dynamic: license-file

### CitySketch

![CitySketch logo](https://github.com/cdruee/citysketch/raw/main/logo/citysketch_logo.png)

A visual building editor for use with AUSTAL
with interactive building placement, 
basemap overlays, and real-time 3D height editing.


### Installation

#### Prerequisites

CitySketch requires the following software components:

**Required Dependencies:**

* Python 3.7 or higher
* wxPython 4.0+
* NumPy

**Optional Dependencies:**

* **rasterio and GDAL**: For GeoTIFF overlay support
* **PyOpenGL and PyOpenGL_accelerate**: For 3D visualization
* **scipy**: For advanced image processing

#### Installing with pip

```bash
pip install citysketch
```

#### Installing from PyPi

1. Clone the repository:

   ```bash
   pip install citysketch
   ```

2. Install all dependencies:

   ```bash
   pip install 'citysketch[full]'
   ```

#### Installing from Source

1. Clone the repository:

   ```bash
   git clone https://github.com/cdruee/citysketch.git
   cd citysketch
   ```

2. Install dependencies:

   ```bash
   pip install -r requirements.txt
   ```

3. Install optional Dependencies

For full functionality, install optional dependencies:

```bash
## For GeoTIFF support
pip install rasterio gdal

## For 3D visualization
pip install PyOpenGL PyOpenGL_accelerate

## For advanced image processing
pip install scipy
```

### First Launch

#### Starting CitySketch

After installation, start CitySketch by running:

```bash
citysketch
```

Or from Python:

```python
from citysketch.AppMain import main
main()
```
