Skip to content

Latest commit

 

History

History
65 lines (50 loc) · 2.67 KB

README.md

File metadata and controls

65 lines (50 loc) · 2.67 KB

GeoGrapher

GeoGrapher is a Python library for building remote sensing computer vision datasets starting from vector features (e.g. locations or georeferenced bounding boxes or segmentation maks). It connects the features and images by a bipartite graph that keeps track of the containment and intersection relations between them making it suited for object-centric tasks. GeoGrapher also provides highly general and customizable dataset cutting functionality as well as other utility functions.

Installation

This package has two external dependencies:

The package itself (and its Python dependencies) can be installed with

pip install GeoGrapher

Getting started

Read our our blogpost for an introduction to GeoGrapher, try out the tutorial notebooks in the notebooks directory, or read the documentation.

Development

To create a local dev installation, clone the repo, cd into the repo folder, and use the commands

python -m venv geographer-env
source geographer-env/bin/activate
make -B venv

to create a virtual environment, activate it, and create an editable local installation of the package and its dependencies.

Use the make format, make lint, make test, and make docs commands to format, lint, or test the code or to create the documentation locally.

To create the documentation locally, you will need to install the pandoc external dependency following the instructions here https://pandoc.org/installing.html.

Contributing to GeoGrapher

You can contribute by giving feedback, opening an issue, submitting feature requests or bug reports, or submitting pull requests.

Show your support

Give this project a star if you like it!

Contact

Contact the maintainer at @rustamdantia.

License

This project is licensed under a version of the Hippocratic License that in particular prohibits use for military activites. You can find a copy of the license here.

Hippocratic License HL3-CL-ECO-MIL