Metadata-Version: 2.4
Name: hypercadaster_ES
Version: 1.0.0
Summary: Python library to obtain the Spanish cadaster data joined with external attributes.
Home-page: https://github.com/BeeGroup-cimne
Author: Jose Manuel Broto Vispe
Author-email: jmbrotovispe@gmail.com
License: EUPL-1.2
Keywords: cadastral data,geospatial,spain,gis,real estate
Classifier: Development Status :: 4 - Beta
Classifier: Intended Audience :: Developers
Classifier: Intended Audience :: Science/Research
Classifier: License :: OSI Approved :: European Union Public Licence 1.2 (EUPL 1.2)
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3.10
Classifier: Programming Language :: Python :: 3.11
Classifier: Programming Language :: Python :: 3.12
Classifier: Topic :: Scientific/Engineering :: GIS
Classifier: Topic :: Software Development :: Libraries :: Python Modules
Classifier: Operating System :: OS Independent
Requires-Python: >=3.10
Description-Content-Type: text/markdown
License-File: LICENSE
Requires-Dist: numpy<3.0,>=1.24
Requires-Dist: scipy<2.0,>=1.10
Requires-Dist: pandas<3.0,>=2.1
Requires-Dist: polars<2.0,>=1.0
Requires-Dist: scikit-learn<2.0,>=1.3
Requires-Dist: joblib>=1.3
Requires-Dist: threadpoolctl>=3.3
Requires-Dist: dask>=2024.4
Requires-Dist: cloudpickle>=3.0
Requires-Dist: toolz>=0.12
Requires-Dist: partd>=1.4
Requires-Dist: shapely<3.0,>=2.0
Requires-Dist: pyproj<4.0,>=3.5
Requires-Dist: rasterio<2.0,>=1.3
Requires-Dist: fiona<2.0,>=1.9
Requires-Dist: geopandas<1.1,>=0.13
Requires-Dist: pyogrio<1.0,>=0.8
Requires-Dist: affine>=2.4
Requires-Dist: snuggs>=1.4
Requires-Dist: pygeoif>=0.7
Requires-Dist: osmnx<2.1,>=1.8
Requires-Dist: networkx>=3.2
Requires-Dist: pyarrow>=14.0
Requires-Dist: openpyxl>=3.1
Requires-Dist: et-xmlfile>=1.1
Requires-Dist: requests<3.0,>=2.31
Requires-Dist: urllib3<3,>=2.1
Requires-Dist: charset-normalizer>=3.3
Requires-Dist: idna>=3.6
Requires-Dist: certifi>=2024.2
Requires-Dist: beautifulsoup4>=4.12
Requires-Dist: soupsieve>=2.5
Requires-Dist: xmltodict>=0.13
Requires-Dist: matplotlib<4,>=3.8
Requires-Dist: contourpy>=1.2
Requires-Dist: cycler>=0.12
Requires-Dist: kiwisolver>=1.4
Requires-Dist: fonttools>=4.53
Requires-Dist: pillow>=10.2
Requires-Dist: click>=8.1
Requires-Dist: click-plugins>=1.1
Requires-Dist: cligj>=0.7
Requires-Dist: packaging>=23.2
Requires-Dist: python-dateutil>=2.8.2
Requires-Dist: pytz>=2024.1
Requires-Dist: tzdata>=2024.1
Requires-Dist: regex<2027.0,>=2023.12
Requires-Dist: tqdm>=4.66
Requires-Dist: six>=1.16
Requires-Dist: PyYAML>=6.0
Provides-Extra: dev
Requires-Dist: black>=24.0; extra == "dev"
Requires-Dist: ruff>=0.4; extra == "dev"
Requires-Dist: pytest>=7.0; extra == "dev"
Requires-Dist: pytest-cov>=4.0; extra == "dev"
Dynamic: author
Dynamic: author-email
Dynamic: classifier
Dynamic: description
Dynamic: description-content-type
Dynamic: home-page
Dynamic: keywords
Dynamic: license
Dynamic: license-file
Dynamic: provides-extra
Dynamic: requires-dist
Dynamic: requires-python
Dynamic: summary

# hypercadaster_ES

A comprehensive Python library for downloading, processing, and analyzing Spanish cadastral data with integration of external geographic datasets.

[![Python Version](https://img.shields.io/badge/python-3.10+-blue.svg)](https://python.org)
[![License](https://img.shields.io/badge/license-EUPL%20v1.2-blue.svg)](https://joinup.ec.europa.eu/collection/eupl/eupl-text-eupl-12)
[![Version](https://img.shields.io/badge/version-1.0.0-green.svg)](https://github.com/BeeGroup-cimne/hypercadaster_ES)

## 🎯 Overview

**hypercadaster_ES** is a powerful Python library designed for comprehensive analysis of Spanish cadastral data. It provides tools for downloading official cadastral information, integrating it with external geographic datasets, and performing advanced building analysis including geometric inference, orientation analysis, and energy simulation data preparation.

### Key Features

- 🏘️ **Comprehensive Cadastral Data Access**: Download building, parcel, and address data from Spanish cadastral services
- 🗺️ **Multi-source Data Integration**: Merge with census tracts, postal codes, elevation models, and OpenStreetMap data
- 🏗️ **Advanced Building Analysis**: Geometric inference, floor footprint calculation, and building space classification
- 📊 **Orientation & Environmental Analysis**: Building orientation analysis, street relationships, and shadow calculations
- 🔌 **External Tool Integration**: Export capabilities for building energy simulation tools
- 📈 **Scalable Processing**: Optimized for large-scale municipal and provincial analysis

## 📚 Documentation

### Getting Started
- [**Installation & Quick Start**](docs/installation-quickstart.md) - Installation methods, basic usage, and first steps
- [**Configuration & Examples**](docs/configuration-examples.md) - Advanced configuration and example workflows

### Library Reference
- [**Library Structure**](docs/library-structure.md) - Detailed module documentation and function reference
- [**Data Sources & Coverage**](docs/data-sources-coverage.md) - Available datasets and geographic coverage
- [**Output Data Schema**](docs/output-schema.md) - Complete data structure and column reference

### Applications & Use Cases
- [**Use Cases & Applications**](docs/use-cases-applications.md) - Real-world applications and case studies

### Development
- [**Contributing**](docs/contributing.md) - How to contribute to the project
- [**Changelog**](docs/changelog.md) - Version history and changes

## 🚀 Quick Start

### Installation
```bash
pip install hypercadaster-ES
```

### Basic Usage
```python
import hypercadaster_ES as hc

# Download data for Barcelona municipality
hc.download("./data", cadaster_codes=["08900"])

# Merge all data into a unified GeoDataFrame
gdf = hc.merge("./data", cadaster_codes=["08900"])

# Save results
gdf.to_pickle("barcelona_data.pkl", compression="gzip")
```

For detailed installation instructions and advanced examples, see [Installation & Quick Start](docs/installation-quickstart.md).

## 🎯 Key Applications

- **Urban Planning & Municipal Management**: Building stock analysis, zoning compliance, infrastructure planning
- **Energy & Environmental Analysis**: Building energy modeling, solar potential assessment, carbon footprint analysis
- **Real Estate & Economic Analysis**: Property valuation, market analysis, location intelligence
- **Academic Research**: Urban geography, transportation research, social sciences applications

See [Use Cases & Applications](docs/use-cases-applications.md) for detailed descriptions and examples.

## 📊 Geographic Coverage

- **National Coverage**: Complete coverage of peninsular Spain, Balearic Islands, Canary Islands (except Basque Country and Navarre)
- **Enhanced Coverage**: Additional Barcelona open data layers
- **Scale Range**: Individual buildings to entire autonomous communities

## 🏗️ Advanced Features

- **Building Inference Engine**: Advanced geometric analysis, floor footprint calculation, orientation analysis
- **Multi-source Integration**: Cadastral, census, elevation, postal, and OpenStreetMap data
- **CAT Files Support**: Detailed building space classification from official cadastral CAT format
- **Energy Simulation Ready**: Export formats compatible with building energy simulation tools

## 👥 Authors & Contributors

**Primary Authors:**
- **Jose Manuel Broto Vispe** - jmbrotovispe@gmail.com
- **Gerard Mor** - gmor@cimne.upc.edu

**Institutional Affiliations:**
- **CIMNE** - Centre Internacional de Mètodes Numèrics en Enginyeria, Building Energy and Environment (BEE) group
- **Universitat Politècnica de Catalunya (UPC)** - Technical University of Catalonia

## 📄 License

This project is licensed under the **EUPL v1.2**. See the [license](https://joinup.ec.europa.eu/collection/eupl/eupl-text-eupl-12) for details.

---

*hypercadaster_ES - Built with ❤️ for the Spanish urban analysis and building research community*

*Last updated: August 2025 | Version 1.0.0*
