README.md

Building Identification

This is a work in progress project to use Sentinel data to identify buildings.

See the scripts for more information on how to run different parts of the pipeline.

Setup

Anaconda running python 3.6 is used as the package manager. To get set up with an environment, install Anaconda from the link above, and (from this directory) run

conda env create -f environment.yml

This will create an environment named okra-buildings with all the necessary packages to run the code. To activate this environment, run

conda activate okra-buildings

Running this code also requires you to sign up to Earth Engine. Once you have done so, active the okra-buildings environment and run

earthengine authenticate

and follow the instructions. To test that everything has worked, run

python -c "import ee; ee.Initialize()"

Note that Earth Engine exports files to Google Drive by default (to the same google account used sign up to Earth Engine).

Dev

Black is used for code formatting.

mypy is used for type hints.

pytest is our test runner.

These can be run with the following commands (from the project root):

black .
mypy src
pytest