geop4th 0.12.0a3

GEOP4TH (for GEOspatial Python Pre-Processing Platform for Trajectories in Hydro-socio-ecosystems) is a collection of generic, format-agnostic, python tools (geobricks) designed to easily standardize, manipulate and visualize space-time data.

GEOP4TH

Presentation

GEOP4TH /ʤiɒpɑːθ/ jee-uh-pa-th (for GEOspatial Python Pre-Processing Platform for Trajectories in Hydro-socio-ecosystems) is a collection of generic, format-agnostic, python tools (geobricks) designed to easily standardize, manipulate and visualize space-time data.

Besides, these geobricks are designed to be assembled into complete pre-processing workflows for specific data or to specific applications (models, data visualization...). Such workflows can be collaboratively developped and shared within GEOP4TH. So far, GEOP4TH includes for instance the workflows for pre-processing some of the most common French datasets (SIM2, DRIAS/EXPLORE2, BNPE, IGN...) and some major international datasets (ERA5, C3S seasonal forecasts...) as well as the workflows to format inputs for CWatM. Collaborative developments are welcome :)

Beyond its general purposes, and due to the history of its development and of the tools included, GEOP4TH carries a thematic "connotation" towards hydro-socio-ecosystems trajectories and diagnostics.

URL of the main source: https://gitlab.com/AlexandreCoche/geop4th

{width=750}

Documentation

The most up-to-date documentation can be found online at:

• 📗 Documentation : https://AlexandreCoche.gitlab.io/geop4th

Note Additionnaly, this documentation can be accessed offline through the public/index.html file on the doc branch

Getting started

Note
Latest quickstart instructions are described in the Documentation with more details.

GEOP4TH works under Python >= 3.11. Once Python installed, GEOP4TH can be installed with

pip install geop4th

Then, the main modules can be imported in your IDE as follow:

# Basics elements
import geop4th as geo

Note that if you do not have any, you can install an IDE (for instance Spyder) with:

pip install spyder

Docker image

A Docker image of 0.10.1 version (outdated) is available here: https://hub.docker.com/r/alexandrecoche/geop4th.

Support

[e-mail], and specify geop4th in the email subject.

Project status

Currently under developpement and maturation.

Roadmap

Details in the ROADMAP.md file.

Authorship & contributions

Contribute

Please have a look at the CONTRIBUTING.md file.

Installation requirements for contributors

If you want to install GEOP4TH for contributing, please refer to the online Documentation.

Instructions in a nutshell:

1. Clone the git folder
2. Install the Python environment (in "your/path/to/geop4th/install/environment.yml")
   • GEOP4TH requires some common open-source python packages (xarray, rioxarray, rasterio, numpy, pandas, geopandas, shapely, fiona, pysheds, plotly, matplotlib)
3. After activating this environment, install and open an IDE
4. Import modules (as above in Getting started)

Note that GEOP4TH requires some common open-source python packages (xarray, rioxarray, rasterio, numpy, pandas, geopandas, shapely, fiona, pysheds, plotly, matplotlib).

Authors and acknowledgment

This work has been created by Alexandre Kenshilik Coche, in part as a personal project and in part under research contracts (Université de Rennes 1, Université Rennes 2, CNRS), with the help of the following first contributors: Many major developments on functionalities, installation procedure, program structure, and others, have been realised by Bastien Boivin. The design of the trajplot figures was conceived with the help of Laurent Longuevergne, Elias Ganivet and Veronique Van Tilbeurgh.
Part of the functions to handle SIM2 data were conceived with the help of Ronan Abhervé and some code parts from Loïc Duffar's scripts.
Packing functions were based on James Hiebert's work. Alexandre Gauvain shared insightful ideas on how to structure the gitlab and the ReadTheDocs documentation. Pape Saara Ngom provided helpful advice to improve the installation procedure. Damien Belvèze and Martin Komlavi Amouzou brought a significant help and crucial advice on software development good practices, replicability, testing and containerization. Last but not least, programmer web communities brought a tremendous help to this work.

To see a more detailled and up-to-date view on authors and contributors, please refer to the codemeta.json file.

Funding

This work has been partly funded by PAGAIE ANR research project (EOTP776392) and the "Ressources en Eau du futur" Rennes Métropole Chaire (19JA305-01D).

License

ESCAPE License See the COPYING file, as well as the NOTICE file for further explanations about the license and the reasons behind its choice.

Important Note: The usage and distribution of GEOP4TH is not granted to for-profit organizations.

---