geop4th 0.11.0

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 models. Such workflows can be collaboratively developped and shared within GEOP4TH. So far, GEOP4TH includes the workflows for pre-processing some of the most common French datasets (SIM2, DRIAS/EXPLORE2, BNPE, IGN...), as well as the workflows to format inputs for CWatM. Collaborative developments are welcome :)

In the end, GEOP4TH intends to help working on 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
from geop4th import (
    geobricks as geo,
    download_fr as dlfr,
    trajplot as tjp,
    )
	
# or complete workflows
from geop4th import (
    standardize_fr as stzfr,
    cwatm,
    )

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 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.

Roadmap

• implement download and standardize functions for ERA5 data
• document essential functions
• finish documenting all the functions
• add some example files
• solve watershed functions issues (compatibility with pysheds 0.5)
• implement a comparison function
• generalize data paths in trajplot and document it
• for contributing, test and resolve the installation procedure with pip
• implement logging everywhere and add a workflow log
• clean code (remove useless commented sections, merge georef from standardize_fr.py into other functions, restructure SIM2_tools and advanced_visualization...)

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.

Nevertheless, here are a summary of the instructions:

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)

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, with the help of the following first contributors: 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. Bastien Boivin and 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. Programmer web communities brought a considerable 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

GNU GPLv3 see the COPYING file.

---