Metadata-Version: 2.1
Name: geometron
Version: 0.1.14
Summary: Tools for operations on geometrical objects
Author-email: "O. Kaufmann" <olivier.kaufmann@umons.ac.be>
Maintainer: All the contributors
License: GPLv3.0
Classifier: Programming Language :: Python :: 3
Classifier: Operating System :: OS Independent
Requires-Python: >=3.8
Description-Content-Type: text/markdown
License-File: LICENSE
License-File: AUTHORS
Requires-Dist: matplotlib>2.2.0
Requires-Dist: numpy<2.0.0,>=1.26.1
Requires-Dist: pandas
Requires-Dist: geopandas
Requires-Dist: scipy
Requires-Dist: shapely
Requires-Dist: pyvista
Requires-Dist: descartes
Requires-Dist: pillow
Requires-Dist: requests
Requires-Dist: pyparsing<3
Requires-Dist: rasterio
Requires-Dist: svgpath2mpl
Requires-Dist: svgpathtools
Requires-Dist: rasterio
Requires-Dist: svgpath2mpl

# geometron  
### O. KAUFMANN, 2021-2024.  
  
The geometron packages aims at providing tools for 2D/3D geometrical operations in the scope of geosciences.

[![Documentation](https://readthedocs.org/projects/geometron/badge/?version=latest)](https://geometron.readthedocs.io/en/latest/?badge=latest
)
[![License](https://img.shields.io/badge/License-GPLv3-blue.svg)](https://www.gnu.org/licenses/gpl-3.0)


## Table of Contents
1. [Description of the project](#Description-of-the-project)
2. [Prerequisites](#Prerequisites)
3. [Installation](#Installation)
4. [Contributing](#Contributing)
5. [License](#License)
6. [Citation](#Citation)
7. [Contact](#Contact)

## Description of the project <a name="Description-of-the-project"></a>

@@@ Please insert a project description here!  

## Prerequisites <a name="Prerequisites"></a>

@@@ Please insert prerequisites here!

## Contributing <a name="Contributing"></a>

The project is developed in a virtual environment using pipenv. It is therefore necessary to install pyenv and pipenv before starting the installation of the program.  

Pyenv will setup the virtual environment with the correct version of Python. Pipenv will add the required python dependencies automatically during installation.  

Refer to this [link](https://github.com/pyenv/pyenv-installer) to install Pyenv and this [link](https://pipenv.pypa.io/en/latest/install/) to install Pipenv, the prerequisites.  
## Installation <a name="Installation"></a>
To clone the repository and setup the environment for using this project :

.. code-block:: bash 

   $  git clone git@gfa-gitlab.umons.ac.be:kaufmanno/geometron.git  
   $  cd geometron/  
   $  pipenv shell  
   $  pipenv install   

To view installed dependencies, see the [Pipfile](https://gfa-gitlab.umons.ac.be/kaufmanno/geometron/blob/master/Pipfile). Be aware that using *pipfile install* actually installs from the Pipfile.lock file. Use the --skip-lock option if you want to use the Pipfile instead.

When contributing to this repository, please first discuss the change you wish to make via issue, email, or any other method with the owners of this repository before making a change.

Also have a look at this note about [contributing](https://gfa-gitlab.umons.ac.be/kaufmanno/geometron/blob/master/CONTRIBUTING.md).  

Please note we have a [code of conduct](https://gfa-gitlab.umons.ac.be/kaufmanno/geometron/blob/master/CODE_OF_CONDUCT.md), please follow it in all your interactions with the project.  


## License <a name="License"></a>

The license of the project is available on the [license](https://gfa-gitlab.umons.ac.be/kaufmanno/geometron/blob/master/LICENSE) file.  

## Citation <a name="Citation"></a>

@@@ Please provide a citation here!  

## Contact <a name="Contact"></a>

We are interested in your feedback. Please create issues for bug reports, suggestions, PR and questions.  
