Skip to main content

Render xarray timestacks into GIFs

Project description

GeoGIF

Documentation Status

Make GIFs from time-stacked xarray.DataArrays (time, [optional band], y, x), dead-simple.

from geogif import gif, dgif
gif(data_array)
dgif(dask_data_array).compute()

Animation of shoreline moving on the coast of Cape Cod

The "geo" part is a lie, actually. The arrays don't have to be geospatial in nature. But I called it GeoGIF because:

  1. Wanting to animate a time-stack of imagery (like you'd get from stackstac) is a common task in the earth-observation/geospatial world.
  2. I think GeoGIF is a hilarious idea1.

1: To ruin the joke, it sounds like GeoTIFF, a ubiquitous geospatial image format. If you also think this is a funny idea, and believe you'd have a better use for the name than I do, I'd happily cede it to you.

Installation

pip install geogif

Documentation

See https://geogif.readthedocs.io/en/latest/.

Development

GeoGIF is managed by Poetry, so be sure that's installed first. To develop locally, first fork or clone the repo. Then, to set up a virtual environment and install the necessary dependencies:

cd geogif
poetry install

Running Tests

GeoGIF has some basic end-to-end tests, written with Hypothesis. To run:

pytest

This will take ~30 seconds (longer the first time), as Hypothesis generates fake data to root out possible errors.

Code style

GeoGIF is formatted with shed, in order to allow for as few opinions as possible.

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

geogif-0.2.tar.gz (8.4 kB view details)

Uploaded Source

Built Distribution

geogif-0.2-py3-none-any.whl (8.8 kB view details)

Uploaded Python 3

File details

Details for the file geogif-0.2.tar.gz.

File metadata

  • Download URL: geogif-0.2.tar.gz
  • Upload date:
  • Size: 8.4 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: poetry/1.7.1 CPython/3.9.4 Darwin/22.6.0

File hashes

Hashes for geogif-0.2.tar.gz
Algorithm Hash digest
SHA256 91c08b3a2cfa73ac7be5d8523d645e9d05d7a2a131667f771758fa3feee3f4f3
MD5 9926c24f61aef434ef71ed81f38a7c14
BLAKE2b-256 d3aeb97d27bc549d690f083fda813f7e601224724629aa848413acdb33ad4a39

See more details on using hashes here.

File details

Details for the file geogif-0.2-py3-none-any.whl.

File metadata

  • Download URL: geogif-0.2-py3-none-any.whl
  • Upload date:
  • Size: 8.8 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: poetry/1.7.1 CPython/3.9.4 Darwin/22.6.0

File hashes

Hashes for geogif-0.2-py3-none-any.whl
Algorithm Hash digest
SHA256 87e0b8233abedd723ef4092e321f7b7020c6270cfc032236c814f315e4f4c829
MD5 196bfd3cf4dd1d18642b488e3a8984e5
BLAKE2b-256 0f49dfe35363818fd47372897929828f3cc47e951046582171caa78a3a3ef5ad

See more details on using hashes here.

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