Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/kartverket/geomcompare

Compare two sets of geometrical features.
https://github.com/kartverket/geomcompare

change-detection geodata geometry vector

Last synced: 17 days ago
JSON representation

Compare two sets of geometrical features.

Awesome Lists containing this project

README

        

.. These are examples of badges you might want to add to your README:
please update the URLs accordingly

.. .. image:: https://api.cirrus-ci.com/github//GeomCompare.svg?branch=main
.. :alt: Built Status
.. :target: https://cirrus-ci.com/github//GeomCompare
.. .. image:: https://readthedocs.org/projects/GeomCompare/badge/?version=latest
.. :alt: ReadTheDocs
.. :target: https://GeomCompare.readthedocs.io/en/stable/
.. .. image:: https://img.shields.io/coveralls/github//GeomCompare/main.svg
.. :alt: Coveralls
.. :target: https://coveralls.io/r//GeomCompare
.. .. image:: https://img.shields.io/pypi/v/GeomCompare.svg
.. :alt: PyPI-Server
.. :target: https://pypi.org/project/GeomCompare/
.. .. image:: https://img.shields.io/conda/vn/conda-forge/GeomCompare.svg
.. :alt: Conda-Forge
.. :target: https://anaconda.org/conda-forge/GeomCompare

===========
GeomCompare
===========

Compare two sets of geometrical features.

*GeomCompare* provides multiple tools for comparing two independant
sets of geometrical features. It can be used to identify features with
similar geometry (based on pre-defined similarity functions) found in
both sets, as well features with geometry that are found in only one
of the sets. *GeomCompare* defines a few similarity functions, but it
possible for the user to define its own customized similarity
functions.

.. _installation:

Installation
------------

Requirements
""""""""""""

*GeomCompare* requires ``Python >= 3.9``.

In addition, for a fully fledged installation of *GeomCompare* and
to have access to all functionalities provided by the library, the
user need to install the following:

* ``shapely``
* ``numpy``
* ``psycopg2``
* ``rtree``
* ``pyproj``
* ``gdal`` (core libraries and Python bindings)
* ``spatialite``

.. note::

``mod_spatialite`` must be installed and accessible from ``sqlite3``:

.. code-block:: python

import sqlite3
conn = sqlite3.connect(":memory:")
conn.enable_load_extension(True)
conn.load_extension("mod_spatialite")

PIP
"""

If you use ``pip``, you can install *GeomCompare* with:

``pip install geomcompare``

Docker
------

A *Docker* image for *GeomCompare* is also available on *DockerHub*:

* Run the geomcompare image and start an iPython session inside the container:

``docker run -it mtachon/geomcompare``

* Run the geomcompare image, and mount the current directory into the
*data* folder of the container:

``docker run --entrypoint bash -v `pwd`:/data -w /data -it mtachon/geomcompare``

For more information on *Docker* and command-line arguments, see:
https://docs.docker.com/ and
https://docs.docker.com/engine/reference/run/ .

Usage
-----

For guidance on how to use *GeomCompare*, a user guide and API
documentation are available on the project's
homepage (https://geomcompare.readthedocs.io/en/latest/).