Skip to main content

Land-use land-cover analysis using Dynamic World App from Earth Engine

Project description

dynamic-world

Package that allow for remote monitoring of reforested forests based around Google's Dynamic World App (see attributions bellow).

Install

pip install dynamic-world

Usage

Given a Forest (defined as a directory with some configuration files, see bellow), this package retrieves statistics and images. See Jupyter tutorial for a usage example.

Forests

Each forest (or "proyect") is stored inside a directory with a given name. Inside this directory there must be 2 files:

  • a forest_config.yml (name is mandatory) which looks like this:
# Name of the forest/proyect
name : Sample

# Locations of the geojson file and dcitionary with carbon factor/metric
geojson : './sample.geojson'
carbon_factor : {
    "trees" : 1,
    "other" : 0, # MUST contain this label
    "factor_pixel" : 1 # MUST contain this label
}

# Date in which the reforestation started, in format YYYY-mm-dd
start_date: '2022-01-01'
  • a valid geojson file see (named as defined in forest_config.yml) that defines the area

Internally, forests are stored as a ForestConfig instance (see dynamic_world.configurations for more details).

Available calculations

Given a forest and a pair of dates, we download the forest's landcover image, landcover statistics and carbon factor [^cf_foot] calculation.

[^cf_foot]: by carbon factor we mean the amount of CO2 (measured in tons) that a forest stores (and therefore is not released into the atmosphere :D)

The forest image is stored inside a Cloud Optimized Geotiff file. The expression used for the file-name is the following:

f"{forest.name.replace(' ', '_')}_{start_date}_{end_date}.cog.tif"

For reductions we use the Mode (polling). If a very large time interval is specified, recent changes in the forest will be masked by old pixel values. It is encouraged to use the smallest possible time intervals (at least a week is required or there may not be data). However, depending on some factors (such as the amount of clouds), specifying a small time interval may result in many NA (see mrv.calculations documentation for further info on how NA are treated when calculating the carbon factor).


Attributions

This dataset is produced for the Dynamic World Project by Google in partnership with National Geographic Society and the World Resources Institute.


Development notes

How to run tests locally

  • to test run 'pytest' in the root directory of the proyect
  • to run coverage use 'pytest --cov mrv --cov-branch --cov-report term-missing --disable-warnings'

How to run tests in docker

The easiest is to use VScode functionality "Reopen in container" which is quite nicer for development. Alternaitvely:

# Build test docker
docker build --tag dw --file Dockerfile --target dev .

# Run lint and tests
docker run dw /bin/bash -c "flake8 && pytest"

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

dynamic-world-0.1.0.tar.gz (14.8 kB view hashes)

Uploaded Source

Built Distribution

dynamic_world-0.1.0-py3-none-any.whl (15.8 kB view hashes)

Uploaded Python 3

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page