Metadata-Version: 2.4
Name: pygeomatch
Version: 0.0.2
Summary: A package to match geographical features
Author: Paul Guardiola, Juste Raimbault, Ana-Maria Raimond, Julien Perret, Nicolas Audebert
Author-email: Paul Guardiola <Paul.Guardiola@ign.fr>, Juste Raimbault <Juste.Raimbault@ign.fr>, Ana-Maria Raimond <Ana-Maria.Raimond@ign.fr>, Julien Perret <Julien.Perret@ign.fr>, Nicolas Audebert <Nicolas.Audebert@ign.fr>
License-Expression: GPL-3.0-or-later
License-File: LICENSE
Classifier: Programming Language :: Python :: 3
Classifier: Operating System :: OS Independent
Requires-Dist: bitarray>=3.8.0
Requires-Dist: geopandas>=1.0.1
Requires-Dist: more-itertools>=10.8.0
Requires-Dist: pot>=0.9.6.post1
Requires-Dist: typer>=0.21.1
Requires-Python: >=3.9
Project-URL: Homepage, https://github.com/umrlastig/pygeomatch/
Project-URL: Issues, https://github.com/umrlastig/pygeomatch/issues
Description-Content-Type: text/markdown

# pygeomatch

Python library for matching geospatial vector datasets.
For now, we only have surface matching algorithms but others will come soon.

# installation

## from source

```shell
git clone git@github.com:umrlastig/pygeomatch.git
cd pygeomatch
```

[Install uv](https://docs.astral.sh/uv/getting-started/installation/#installation-methods)

Install dependencies:
```shell
uv sync
```

```shell
source .venv/bin/activate
```

## with pip

```shell
pip install pygeomatch
```

# usage

You can now use the *pygeomatch* script to match your data.
You can see the different parameters with:
```shell
pygeomatch --help
```

For instance, with the test data in directory *data* using the *MCA* algorithm and saving the results in *test.gpkg*, you can use the following:
```shell
pygeomatch data/popRef.shp data/popComp.shp test.gpkg MCA
```

# Run tests

```shell
pytest -v --cov  --cov-report term-missing
```

## References

### Included matching algorithms

Ali, A. B. H. (2001). Qualité géométrique des entités géographiques surfaciques. Application à l'appariement et définition d'une typologie des écarts geométriques (Doctoral dissertation, université Gustave Eiffel).

Olteanu-Raimond, A. M., Mustiere, S., & Ruas, A. (2015). Knowledge formalization for vector data matching using belief theory. Journal of Spatial Information Science, (10), 21-46.

### More to be included

Du, H. (2015). Matching disparate geospatial datasets and validating matches using spatial logic (Doctoral dissertation, University of Nottingham).

Yan, Y., Sun, Y., Wang, S., Lu, Y., Hu, Y., & Lu, M. (2025). Research on Multi-Scale Vector Road-Matching Model Based on ISOD Descriptor. ISPRS International Journal of Geo-Information, 14(7), 280.

## Data

Ground-truth OSM/BDTopo centre Strasbourg (stage) [-> link BiblioDocs]

