Metadata-Version: 2.4
Name: forgeo
Version: 0.6.4
Summary: BRGM geological modelling framework
Author-email: BRGM <forgeo@brgm.fr>
Maintainer: Leana QUIMERCH, Nicolas CLAUSOLLES, Simon LOPEZ, Thomas JANVIER
License-Expression: AGPL-3.0-or-later
Project-URL: homepage, https://brgm.gitlab.io/geomodelling/forgeo/
Project-URL: repository, https://gitlab.com/brgm/geomodelling/forgeo-core
Requires-Python: >=3.3
Description-Content-Type: text/markdown
License-File: LICENSE
Requires-Dist: attrs
Requires-Dist: numpy
Requires-Dist: defusedxml
Provides-Extra: test
Requires-Dist: pytest; extra == "test"
Requires-Dist: matplotlib; extra == "test"
Requires-Dist: vtkwriters; extra == "test"
Dynamic: license-file

# forgeo

**BRGM geological modelling framework**

## Usage

:book: see the [documentation](https://brgm.gitlab.io/geomodelling/forgeo/) :book:  

## Installation

`fogeo` releases are deployed to [PyPI](https://pypi.org/project/forgeo/), they can be installed using:
```sh
pip install forgeo
```
Meanwhile one can build it manually from gitlab:
```bash
pip install git+https://gitlab.com/brgm/geomodelling/forgeo-interpolation
```
To locally build/install this package, use:
```sh
git clone https://gitlab.com/brgm/geomodelling/forgeo-core
cd forgeo-core
# regular install
python -m pip install .
# install as editable
python -m pip install -e .
# or package wheel
python -m pip wheel . -w ./dist --no-deps
```

## Contributing

See [CONTRIBUTING.md](CONTRIBUTING.md)

## License
`forgeo` is provided under the GNU General Public License (GPLv3) that can be found in the [LICENSE](LICENSE) file.
By using, distributing, or contributing to this project, you agree to the terms and conditions of this license.

[BRGM nexus]:https://nexus.brgm.fr/
