Metadata-Version: 2.4
Name: geop4th
Version: 0.12.0a3
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>
License: GEOP4TH: GEOspatial Python Pre-Processing Platform for Trajectories in Hydro-socio-ecosystems
        Copyright (C) 2026 GEOP4TH developpers
        
        # Ethical Software Collective Attributive Public with Exceptions License (ESCAPE License)
        version 0.1.0 (2026) or later
        
        This Work (defined below) is protected by copyright and all other applicable laws, and is provided under the terms of this Software Collective Attributive Public with Exceptions License ("License"). By exercising the Licensed Rights (defined below), You accept and agree to be bound by the terms and conditions of this License. To the extent this License may be interpreted as a contract, You are granted the Licensed Rights in consideration of Your acceptance of these terms and conditions, and the Licensor grants You such rights in consideration of benefits the Licensor receives from making the Work available under these terms and conditions.
        
        
        
        ## 1 – DEFINITIONS.
        
        1. "License" refers to this Software Collective Attributive Public with Exceptions License.
        
        2. "Licensor" means the individual(s) or entity(ies) granting rights under this License.
        
        3. "Licensed Rights" means the rights granted to You subject to the terms and conditions of this License, which are limited to all Copyright that apply to Your Use of the Work and that the Licensor has authority to license.
        
        4. "Copyright" means copyright and/or similar rights closely related to copyright.
        
        5. "Work" refers to this program and any part of it, or to any copyrightable material licensed under this License.
        
        6. "Derivative Work" refers to material subject to Copyright that is derived from or based upon the Work and in which the Work is translated, altered, arranged, transformed, or otherwise modified in a manner requiring permission under the Copyright held by the Licensor.
        
        7. An "Application" is any work that makes Use of an interface provided by the Work, but which is not otherwise based on the Work. Defining a subclass of a class defined by the Work is deemed a mode of using an interface provided by the Work.
        
        8. "Combined Work" is a work produced by combining or linking an Application with the Work. The particular version of the Work with which the Combined Work was made is also called the “Linked Version”. For instance, Python librairies that Use this librairy as a dependency are considered Combined Work.
        
        9. "You" means the individuals or organizations exercising the Licensed Rights under this License who has not previously violated the terms of this License with respect to the Work, or who has received express permission from the Licensor to exercise rights under this License despite a previous violation. "Your" has a corresponding meaning.
        
        10. "Source code" for a work means the preferred form of the work for making modifications to it.
        
        11. "Object code" means any non-source form of a work.
        
        12. "For-Profit Organization" means an organization whose primary intent is directed towards generating profits, or in other words, remunerating capital. It also includes organizations that primarily work for or under a For-Profit Organization, and any contractor hired by a For-Profit Organization in an effort to circumvent the clauses of this License. For-Profit Organizations do not include the following:
        
           - individual person, laboring for themselves.
           - non-profit organization.
           - educational institution.
           - organization that seeks shared profit for all its members, and allows non-members to set the cost of their labor. 
           - organization with owners, where all owners are workers and all workers are owners with equal equity and/or equal vote.
        
        13. "Use" means any utilization, usage, consumption or application of any output that has been yielded from calling a function of this Work, even if
        
        
        
        ## 2 – TERMS AND CONDITIONS.
        
        Subject to the terms and conditions of this License, each Licensor hereby grants You a worldwide, royalty-free, non-sublicensable, non-exclusive, irrevocable (for the duration of the applicable copyright) license, under any patent claims that are owned or controlled by the Licensor and that are necessarily infringed by the use, reproduction, or distribution of the Work, to exercise the Licensed Rights in the Work as stated below:
        
        
        ### 2.1 – Use
        
        You may run the Work, provided that You meet the following conditions:
        
        - You are not a military, a paramilitary, an armed organization of any kind, nor any organization that is working for or under these organizations; and
        - You are not using the Work directly or indirectly for a For-Profit Organization; and
        - You are not using the Work as an effort to, or on behalf of an organization with the intent to, circumvent the aforementioned restrictions.
        
        For the avoidance of doubt, any Use by an organization that is privately owned and managed, and that seeks to generate profit from the labor of employees paid by salary or other wages, is not permitted under this license.
        
        
        ### 2.2 – Redistribution and combined works.
        
        #### Combined Works
        
        You may convey a Combined Work under terms of your choice that, taken together, effectively do not restrict modification of the portions of the Work contained in the Combined Work and reverse engineering for debugging such modifications, if you also do each of the following:
        
        - Give prominent notice with each copy of the Combined Work that the Work is Used in it and that the Work and its Use are covered by this License; and
        - Accompany the Combined Work with a copy of this license document; and
        - For a Combined Work that displays copyright notices during execution, include the copyright notice for the Work among these notices.
        
        This allows other programs to link to the Work and be redistributed without the requirement for the linking program to also be licensed under the same terms as the Work.
        BUT, as the embedded Work retains this license, the usage restriction still applies on any Combined Work functionality relying on this Work. Therefore, different use restrictions will apply to different parts of the Combined Work.
        
        #### Derivative Works
        
        You may reproduce and distribute copies of the Work or Derivative Works thereof in any medium, with or without modifications, and in Source or Object form, provided that You meet the following conditions:
        
        - You are effectively granting the right to use any patents needed to exercise the licensed rights; and
        - You must give any other recipients of the Work or Derivative Works a copy of this License; and
        - You must cause any modified files to carry prominent notices stating that You modified the files; and
        - You must retain, in the Source form of any Derivative Works that You distribute, all copyright, patent, trademark, and attribution notices from the Source form of the Work, excluding those notices that do not pertain to any part of the Derivative Works; and
        - If the Work includes a "NOTICE" text file as part of its distribution, then any Derivative Works that You distribute must include a readable copy of the attribution notices contained within such NOTICE file, excluding those notices that do not pertain to any part of the Derivative Works, in at least one of the following places: within a NOTICE text file distributed as part of the Derivative Works; within the Source form or documentation, if provided along with the Derivative Works; or, within a display generated by the Derivative Works, if and wherever such third-party notices normally appear. The contents of the NOTICE file are for informational purposes only and do not modify the License. You may add Your own attribution notices within Derivative Works that You distribute, alongside or as an addendum to the NOTICE text from the Work, provided that such additional attribution notices cannot be construed as modifying the License.
        
        
        ### 2.3 – Submission of Contributions.
        
        Unless You explicitly state otherwise, any Contribution intentionally submitted for inclusion in the Work by You to the Licensor shall be under the terms and conditions of this License, without any additional terms or conditions. Notwithstanding the above, nothing herein shall supersede or modify the terms of any separate license agreement you may have executed with Licensor regarding such Contributions.
        
        
        ### 2.4 – Disclaimer of Warranties and Limitation of Liability.
        
        A. Unless otherwise separately undertaken by the Licensor, to the extent possible, the Licensor offers the Work as-is and as-available, and makes no representations or warranties of any kind concerning the Work, whether express, implied, statutory, or other. This includes, without limitation, warranties of title, merchantability, fitness for a particular purpose, non-infringement, absence of latent or other defects, accuracy, or the presence or absence of errors, whether or not known or discoverable. Where disclaimers of warranties are not allowed in full or in part, this disclaimer may not apply to You.
        
        B. To the extent possible, in no event will the Licensor be liable to You on any legal theory (including, without limitation, negligence) or otherwise for any direct, special, indirect, incidental, consequential, punitive, exemplary, or other losses, costs, expenses, or damages arising out of this License or Use of the Work, even if the Licensor has been advised of the possibility of such losses, costs, expenses, or damages. Where a limitation of liability is not allowed in full or in part, this limitation may not apply to You.
        
        C. The disclaimer of warranties and limitation of liability provided above shall be interpreted in a manner that, to the extent possible, most closely approximates an absolute disclaimer and waiver of all liability.
        
        
        ### 2.5 – Term and Termination.
        
        A. This License applies for the term of the Copyright licensed here. However, if You fail to comply with this License, then Your rights under this License terminate automatically.
        
        B. Where Your right to Use the Work has terminated under Section 2.5(A), it reinstates upon express reinstatement by the Licensor.
        
        C. For the avoidance of doubt, this Section 2.5(B) does not affect any right the Licensor may have to seek remedies for Your violations of this License.
        
        D. For the avoidance of doubt, the Licensor may also offer the Work under separate terms or conditions or stop distributing the Work at any time; however, doing so will not terminate this License.
        
        E. Sections 1, 2.4, 2.5, 2.6, and 2.7 survive termination of this License.
        
        
        ### 2.6 – Other Terms and Conditions.
        
        A. The Licensor shall not be bound by any additional or different terms or conditions communicated by You unless expressly agreed.
        
        B. Any arrangements, understandings, or agreements regarding the Work not stated herein are separate from and independent of the terms and conditions of this License.
        
        
        ### 2.7 – Interpretation.
        
        A. For the avoidance of doubt, this License does not, and shall not be interpreted to, reduce, limit, restrict, or impose conditions on any Use of the Work that could lawfully be made without permission under this License.
        
        B. If any provision of this License is invalid or unenforceable under applicable law, it shall not affect the validity or enforceability of the remainder of the terms of this License. To the extent possible, if any provision of this License is deemed unenforceable, it shall be automatically reformed to the minimum extent necessary to make it enforceable. If the provision cannot be reformed, it shall be severed from this License without affecting the enforceability of the remaining terms and conditions.
        
        C. No term or condition of this License will be waived and no failure to comply consented to unless expressly agreed to by all the Licensors.
        
        D. Nothing in this License constitutes or may be interpreted as a limitation upon, or waiver of, any privileges and immunities that apply to the Licensor or You, including from the legal processes of any jurisdiction or authority.
        
        (Attribution: This License is heavily based on the Anti-Capitalist Attribution Cooperative License, which is also based on Creative Commons Attribution-NonCommercial-ShareAlike License, as well as The Anti-Capitalist Software License by Everest Pipkin and Ramsey Nasser, and Left Copy Revolutionary License 2.14 by Mat K. Witts.)
        
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: 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: NOTICE.md
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.

***
