Skip to main content

eofigs

Tests Docs License: MIT PyPI DOI

Analysis-aware, publication-ready figures for Earth observation research.

Study area map: Swat valley
Study area map
Trend map: Swat valley NDVI 2001–2024
Trend map
Event composite: Swat hot-dry months
Event composite
Accuracy scatter: ICESat-2 against a DEM
DEM accuracy (ICESat-2)
Significance with false discovery rate control
False discovery rate
House style
House style

More examples in the gallery.

eofigs turns Earth observation analysis outputs (rasters, time series, validation pairs) into journal-ready figures that know the analysis, the variable and the printed size:

  • Recipe figures for common analyses: trend with significance, event composites, and later recovery, burn severity, disturbance and divergence.
  • A variable library with fixed colour maps, symbols and units, so NDVI, LST or GPP look the same in every figure, and their anomalies and trends get zero-centred diverging colours.
  • Print-size rendering: rasters are read and reduced to the pixels the printed figure needs, from its width in mm and its dpi, keeping memory use and PDF size small.
  • Journal presets and one-call export to vector PDF plus 600 dpi PNG or TIFF, with a check of size, resolution, smallest font, font embedding and colour-blind safety.

Installation

pip install eofigs

eofigs needs Python 3.11 or newer. On Windows and macOS, conda-forge is the simplest source of its geospatial libraries; see the installation guide.

Quick start

import numpy as np
import eofigs

eofigs.set_style("elsevier")  # fonts, sizes and widths of the journal
rng = np.random.default_rng(1)
field = rng.gamma(5, 30, 300)  # observed aboveground biomass (Mg ha⁻¹)
model = 0.9 * field + rng.normal(10, 20, 300)  # predicted
fig = eofigs.accuracy_scatter(field, model, variable="agb")
print(fig.eofigs_layout["caption"])  # a ready caption sentence
print(eofigs.check_figure(fig))  # size, dpi, smallest font, fonts, colour-blind safety
eofigs.save_figure(fig, "fig_agb")  # vector PDF and a 600 dpi raster

More in the quickstart and the gallery.

Run with Docker

A container image with eofigs and its geospatial stack (cartopy, rioxarray, geopandas, fonts) is published on GitHub Container Registry for each release (0.2.0, latest; dev follows the main branch):

docker run --rm -v "$PWD":/work ghcr.io/kmkamilkhel/eofigs:0.2.0 python script.py

Roadmap

Available now: set_style, style, new_figure, label_panels, save_figure, check_figure, cvd_preview, tidy_axes, palettes, variable, register_variable, fit_raster, trend, stats.fdr_mask, figure_set, study_area_map, add_north_arrow, add_scale_bar, add_inset, trend_map, event_composite and accuracy_scatter.

Function Purpose
set_style, new_figure, save_figure Journal presets (Elsevier, Springer, MDPI, Wiley, Frontiers, Taylor & Francis), widths in mm, one-call export
check_figure, cvd_preview Size, dpi, smallest font, embedded fonts, colour-blind safety; preview as seen with colour-vision deficiencies
palettes, tidy_axes Built-in palettes and colour maps; a few ticks at round values
figure_set Manuscript figure set with automatic Fig/FigS numbering and a manifest
variable, register_variable Variable library: colour map, symbol, unit, range
fit_raster Reduce large rasters to the pixels the printed figure needs
trend Theil–Sen slope with Mann–Kendall test on a time-series cube; seasonal test with the Hirsch–Slack correction for monthly data
stats.fdr_mask Benjamini–Hochberg false discovery rate control for any array of p-values
study_area_map DEM hillshade, overlay, labelled points, locator inset, graticule, north arrow to true north, scale bar, legend; automatic layout
trend_map Trend map with zero-centred colours, significance dots (optionally with false discovery rate control), optional latitude profile
event_composite Before/during/after anomaly maps with a composite time series; optional false discovery rate control
accuracy_scatter Observed against predicted values with the 1:1 line, a fitted line (Piñeiro et al. 2008), R², RMSE, NMAD and bias, density colours or groups

Released in 0.2: false discovery rate control of significance marks and the seasonal Mann–Kendall test.

Planned: burn severity, recovery, disturbance and divergence recipes, SHAP and partial dependence styling, confusion matrix, Google Earth Engine input through Xee at print scale; an R package with matching function names, after the Python API is stable.

Contributing

Questions and ideas are welcome in Discussions; bugs and feature requests in Issues. See CONTRIBUTING.md and the Code of Conduct.

Citation

If you use eofigs, please cite it. The software is archived on Zenodo: doi:10.5281/zenodo.24053760 covers all versions, and each release has its own DOI (v0.1.1: doi:10.5281/zenodo.24084780). The metadata are in CITATION.cff; the citation page has APA and BibTeX entries.

License

MIT. See LICENSE. Data files have their own licences, listed in DATA_LICENSES.md.

Metadata

Release files for eofigs 0.2.0

For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.

Source distribution (sdist)

Source distribution for eofigs 0.2.0
File Size Uploaded Provenance Actions
eofigs-0.2.0.tar.gz 1.1 MB With provenance Details for eofigs-0.2.0.tar.gz

Built distribution (wheel)

Table of built distributions (wheels) for eofigs 0.2.0
File Interpreter ABI Platform Actions
eofigs-0.2.0-py3-none-any.whl Python 3 none any Details for eofigs-0.2.0-py3-none-any.whl

Total release size: 1.3 MB

Release files / eofigs-0.2.0.tar.gz

Download URL eofigs-0.2.0.tar.gz
Size 1.1 MB
Tags Source
SHA-256 checksum
How to use checksums
a096a81cd445a81f6554c3dfb26cadbe55b2195392f2643609cb0f2a0bc1bb0d
BLAKE2b-256 checksum
How to use checksums
03e8317f2924b6ae96dd1d4d8342424e70560946299b292534871029d0bcd0f4
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
Yes
Uploaded via twine/7.0.0 CPython/3.13.16

Provenance

Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.

PyPI Publish Attestation

PyPI verified that this artifact, at this checksum, originated from the publisher listed below.

Signed by GitHub Actions, verified by PyPI on Nov 11, 2026.

Transparency log

Release files / eofigs-0.2.0-py3-none-any.whl

Download URL eofigs-0.2.0-py3-none-any.whl
Size 184.4 kB
Tags Python 3
SHA-256 checksum
How to use checksums
c1d76a2328afed02317260d0a58602fe5a8e534693d93b220f9f6ca61e319d84
BLAKE2b-256 checksum
How to use checksums
c8ab3e3b616295f9f0f3c13da5fd178a5004dae366b1115476c4d249284b6d96
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
Yes
Uploaded via twine/7.0.0 CPython/3.13.16

Provenance

Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.

PyPI Publish Attestation

PyPI verified that this artifact, at this checksum, originated from the publisher listed below.

Signed by GitHub Actions, verified by PyPI on Nov 11, 2026.

Transparency log

Security for eofigs 0.2.0

Provenance

Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.

Full provenance

Both files in this release have been uploaded with provenance metadata.

Select from 2 files

Attestation for eofigs-0.2.0.tar.gz

PyPI Publish Attestation

PyPI verified that this artifact, at this checksum, originated from the publisher listed below.

Signed by GitHub Actions, verified by PyPI on Nov 11, 2026.

Transparency log

A note on package security

PyPI is a repository for distributing packages, not a service for auditing them. While third-party security researchers and our staff do their best to detect and remove malicious packages, PyPI cannot guarantee the quality, security or suitability of any given package.

To learn more about protecting yourself from malicious actors, visit our package security documentation.

Anthropic, PBC Visionary sponsor Bloomberg Visionary sponsor Hudson River Trading Visionary sponsor Meta Visionary sponsor NVIDIA Visionary sponsor Microsoft Sustainability sponsor Depot Continuous Integration AWS Cloud computing and Security Sponsor Datadog Monitoring Fastly CDN Google Download Analytics Sentry Error logging StatusPage Status page