Metadata-Version: 2.4
Name: geop4th
Version: 0.12.0
Summary: 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.
Author-email: Alexandre Kenshilik Coche <alexandre.co@hotmail.fr>, Bastien Boivin <bastien.boivin@univ-rennes.fr>
Project-URL: homepage, https://gitlab.com/AlexandreCoche/geop4th
Project-URL: documentation, https://AlexandreCoche.gitlab.io/geop4th
Project-URL: docker, https://hub.docker.com/r/alexandrecoche/geop4th
Keywords: dataset pre-processing,data visualization,FAIR,collaborative,toolbox,Python 3,Climate Change,Geography,Hydrology,GIS
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3.11
Classifier: Programming Language :: Python :: 3.12
Classifier: Programming Language :: Python :: 3.13
Classifier: Operating System :: OS Independent
Classifier: Intended Audience :: Science/Research
Classifier: Topic :: Scientific/Engineering :: GIS
Classifier: Topic :: Scientific/Engineering :: Hydrology
Requires-Python: <3.14,>=3.11
Description-Content-Type: text/markdown
License-File: COPYING
License-File: robots.txt
License-File: codemeta.json
Requires-Dist: numpy>1.0.0
Requires-Dist: setuptools>=67
Requires-Dist: rioxarray>=0.10.0
Requires-Dist: pandas>1.0.0
Requires-Dist: geopandas>0.10
Requires-Dist: xarray
Requires-Dist: netCDF4
Requires-Dist: h5netcdf
Requires-Dist: rasterio<2.0,>=1.0
Requires-Dist: shapely>=1.8
Requires-Dist: affine<3.0,>=2.3
Requires-Dist: matplotlib
Requires-Dist: plotly
Requires-Dist: Pillow<12.0,>=11.0
Requires-Dist: kaleido
Requires-Dist: cdsapi
Requires-Dist: openpyxl
Requires-Dist: rosetta-soil
Provides-Extra: test
Requires-Dist: pytest; extra == "test"
Requires-Dist: pytest-cov; extra == "test"
Requires-Dist: packaging; extra == "test"
Provides-Extra: docs
Requires-Dist: sphinx; extra == "docs"
Requires-Dist: numpydoc; extra == "docs"
Requires-Dist: sphinx-rtd-theme; extra == "docs"
Requires-Dist: pydata-sphinx-theme; extra == "docs"
Requires-Dist: sphinx-multiversion; extra == "docs"
Requires-Dist: sphinx-tabs; extra == "docs"
Requires-Dist: sphinx-design; extra == "docs"
Requires-Dist: sphinx-copybutton; extra == "docs"
Requires-Dist: sphinx-togglebutton; extra == "docs"
Dynamic: license-file

# GEOP4TH
[![version](https://gitlab.com/AlexandreCoche/geop4th/-/badges/release.svg?version=latest)](https://gitlab.com/AlexandreCoche/geop4th)  [![Documentation](https://gitlab.com/AlexandreCoche/geop4th/badges/doc/pipeline.svg?key_text=📚+doc)](https://AlexandreCoche.gitlab.io/geop4th)

![preview](imgs/logo_v0.11.2-alt2-beta-smaller.png "Logo")

## 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](https://www.data.gouv.fr/fr/datasets/donnees-changement-climatique-sim-quotidienne/), 
[DRIAS/EXPLORE2](https://www.drias-climat.fr), [BNPE](https://bnpe.eaufrance.fr), [IGN](https://geoservices.ign.fr/bdalti)...) and some major international datasets 
([ERA5](https://cds.climate.copernicus.eu/datasets/reanalysis-era5-land), [C3S seasonal forecasts](https://cds.climate.copernicus.eu/datasets/seasonal-original-pressure-levels)...) as well as the workflows to format inputs for [CWatM](https://cwatm.iiasa.ac.at). 
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

![abstract](imgs/illustration_globale_03short.png "Abstract"){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](public/index.html) on the *doc* branch 

## Getting started

> **Note**  
> Latest quickstart instructions are described in the [Documentation](https://AlexandreCoche.gitlab.io/geop4th) with more details.

*GEOP4TH* works under Python >= 3.11. Once Python installed, *GEOP4TH* can be installed with
```bash
pip install geop4th
```

Then, the main modules can be imported in your IDE as follow:
```python
# Basics elements
import geop4th as geo
```

Note that if you do not have any, you can install an IDE (for instance [Spyder](https://www.spyder-ide.org)) with:
```bash
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
alexandre.co@hotmail.fr, and specify **geop4th** in the email subject.

## Project status
Currently under developpement and maturation.

## Roadmap
Details in the [ROADMAP.md](ROADMAP.md) file.

## Authorship & contributions

### Contribute
Please have a look at the [CONTRIBUTING.md](CONTRIBUTING.md) file.

### Installation requirements for contributors
If you want to install *GEOP4TH* for contributing, please refer to the online [Documentation](https://AlexandreCoche.gitlab.io/geop4th/contributing/contributing.html).

Instructions in a nutshell:
1. Clone the [git folder](https://gitlab.com/AlexandreCoche/geop4th.git)
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](https://github.com/loicduffar).  
Packing functions were based on **James Hiebert**'s [work](http://james.hiebert.name/blog/work/2015/04/18/NetCDF-Scale-Factors.html).
**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](codemeta.json) file.

### Funding
This work has been partly funded by [PAGAIE ANR research project](https://eau-et-territoire.org/le-projet-pagaie/) (EOTP776392) and the "Ressources en Eau du futur" Rennes Métropole Chaire (19JA305-01D).

## License
ESCAPE License
See the [COPYING](COPYING) file, as well as the [NOTICE](NOTICE.md) 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.

***
