Metadata-Version: 2.4
Name: geoenrich
Version: 1.0.1
Summary: A package to enrich your geo-referenced data (e.g. species occurrences) with environmental data.
Author: Gaétan Morand, Taha Nabil, Sylvain Poulain, Julien Barde, David Mouillot
Author-email: gaetan.morand@umontpellier.fr
License: GPL-3.0-only
Project-URL: Tutorial, https://geoenrich.readthedocs.io/en/latest/tutorial.html
Project-URL: Documentation, https://geoenrich.readthedocs.io
Project-URL: Code, https://github.com/morand-g/geoenrich
Project-URL: Bug Tracker, https://github.com/morand-g/geoenrich/issues
Classifier: Programming Language :: Python :: 3
Classifier: Development Status :: 5 - Production/Stable
Classifier: Operating System :: OS Independent
Classifier: Natural Language :: English
Classifier: Topic :: Software Development :: Libraries :: Python Modules
Classifier: Intended Audience :: Science/Research
Classifier: Topic :: Scientific/Engineering :: Bio-Informatics
Classifier: Topic :: Scientific/Engineering :: Atmospheric Science
Classifier: Topic :: Scientific/Engineering :: Information Analysis
Requires-Python: >=3.7
Description-Content-Type: text/markdown
License-File: LICENSE
Requires-Dist: numpy
Requires-Dist: pandas>=2.0.0
Requires-Dist: geopandas
Requires-Dist: netCDF4
Requires-Dist: python-dwca-reader
Requires-Dist: tqdm
Requires-Dist: opencv-python
Requires-Dist: pathlib
Requires-Dist: rasterio
Requires-Dist: matplotlib
Requires-Dist: appdirs
Requires-Dist: geojson_rewind
Requires-Dist: geomet
Requires-Dist: copernicusmarine
Requires-Dist: pyyaml
Dynamic: license-file

# **geoenrich 1.0.1**

[![Read the Docs](https://img.shields.io/readthedocs/geoenrich)](https://geoenrich.readthedocs.io/en/latest/)
[![License](https://img.shields.io/github/license/morand-g/geoenrich?color=green)](https://github.com/morand-g/geoenrich/blob/main/LICENSE)
[![PyPI](https://img.shields.io/pypi/v/geoenrich?color=green)](https://pypi.org/project/geoenrich/)
[![Python versions](https://img.shields.io/pypi/pyversions/geoenrich)](https://www.python.org/downloads/)
[![Last commit](https://img.shields.io/github/last-commit/morand-g/geoenrich)](https://github.com/morand-g/geoenrich/)
[![DOI](https://zenodo.org/badge/DOI/10.5281/zenodo.6458090.svg)](https://doi.org/10.5281/zenodo.6458090)

## Acknowledgment

This project is being developed as part of the G2OI project, cofinanced by the European Union, the Reunion region, and the French Republic.
<div align="center">


<img src="https://github.com/IRDG2OI/geoflow-g2oi/blob/main/img/logos_partenaires.png?raw=True" height="80px">

</div>

## Package description

GeoEnrich provides functionalities to enrich georeferenced events (such as species occurrences) with environmental data from satellites or models. Users can specify a geographic or temporal buffer to include data in the neighbourhood of occurrences into their analyses. Two main outputs are available: a simple summary of the variable in the requested area, or the full data (as a geotiff raster, a png image, or a numpy array).

Sea surface temperature, chlorophyll, and 40 other environmental variables are available natively, and others can easily be added by the user. This package is intended for large numbers of occurrences: local storage is implemented to avoid redundant requests to remote servers.

The package provides functions to retrieve occurrence data directly from GBIF, or open a custom dataset from any source. Arbitrary areas defined by the user can also be enriched.

Documentation on [Read the Docs](https://geoenrich.readthedocs.io).

![Illustration of an occurrence dataset enriched with bathymetry data](geoenrich/data/readme_illus_1.png "Illustration of an occurrence dataset enriched with bathymetry data")

## Installation

Installation instructions are in the documentation, for [python](https://geoenrich.readthedocs.io/en/latest/install.html) and [R](https://geoenrich.readthedocs.io/en/latest/r-install.html).

## Using the package

Jupyter Notebook tutorials are available for [python](https://geoenrich.readthedocs.io/en/latest/tutorial.html) and [R](https://geoenrich.readthedocs.io/en/latest/r-tutorial.html).

## Using the graphic interface

A graphic interface is available through a Docker web app. See instructions [here](geoenrich_dashboard/README.md)


## How to cite

As this package is distributed under a GPLv3 license, you have no obligation to cite the authors when you use it. If you want to cite the package to ensure reproducibility, please consider doing it the following way:

> Morand, G., Nabil, T., Poulain, S., Barde, J. & Mouillot, D. (2026). GeoEnrich v1.0.1: a new tool for scientists to painlessly enrich species occurrence data with environmental variables (v1.0.1). Zenodo. http://doi.org/10.5281/zenodo.6458090

You can find the specific DOI for the version you are using on the [package's Zenodo page](http://doi.org/10.5281/zenodo.6458090).


## Issues and further developments

### User suggestions

Please feel free to raise issues or suggest improvements in the [Issues tab](https://github.com/morand-g/geoenrich/issues).

### Planned improvements

- Enrich an area defined by a shapefile.
