Skip to content

quantifyearth/STAR

Repository files navigation

STAR

An implementation of the threat based STAR biodiversity metric by Muir et al (also known as STAR(t)).

See method.md for a description of the methodology, or scripts/run.sh for how to execute the pipeline.

Running the pipeline

Checking out the code

This repository uses submodules, so once you have cloned it, you need to fetch the submodules:

$ git clone https://github.com/quantifyearth/star.git
$ cd star
$ git submodule update --init --recursive

Running the pipeline

The easiest way to get started will be to run scripts/run.sh under a linux environment.

Running on Ubuntu

The following extra utilities will need to be installed:

  • Reclaimer - a utility for downloading data from various primary sources.
  • Littlejohn - a utility to run jobs in parallel driven by a CSV file.

Running in Docker

There is included a docker file, which is based on the GDAL container image, which is set up to install everything ready to use. You can build that using:

$ docker buildx build -t star .

You can then invoke the run script using this. You should map an external folder into the container as a place to store the intermediary data and final results, and you should provide details about the Postgres instance with the IUCN redlist:

$ docker run --rm -v /some/local/dir:/data \
	-e DB_HOST=localhost \
	-e DB_NAME=iucnredlist \
	-e DB_PASSWORD=supersecretpassword \
	-e DB_USER=postgres \
	star ./scripts/run.sh

Credits

The author of this package is greatly indebted to both Francesca Ridley from the University of Newcastle and Simon Tarr of the IUCN for their guidance and review.

About

An implementation of the STAR biodiversity metric

Resources

License

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published