Metadata-Version: 2.4
Name: forgeo
Version: 0.5.0
Summary: BRGM geological modelling framework
Author: BRGM
Maintainer-email: Leana QUIMERCH <l.quimerch@brgm.fr>, Nicolas CLAUSOLLES <n.clausolles@brgm.fr>, Simon LOPEZ <s.lopez@brgm.fr>, Thomas JANVIER <t.janvier@brgm.fr>
License-Expression: AGPL-3.0-or-later
Project-URL: homepage, https://gitlab.brgm.fr/brgm/geomodelling/forgeo/core
Project-URL: repository, https://gitlab.brgm.fr/brgm/geomodelling/forgeo/core
Requires-Python: >=3
Description-Content-Type: text/markdown
License-File: LICENSE
Requires-Dist: attrs
Requires-Dist: functolite>=0.1.1
Requires-Dist: gmlib>=0.4.4
Requires-Dist: rigs>=0.1.3
Provides-Extra: test
Requires-Dist: pytest; extra == "test"
Requires-Dist: vtkwriters; extra == "test"
Dynamic: license-file

# forgeo

**BRGM geological modelling framework**

## Usage

*TODO: Write & point some documentation*

## Installation

`forgeo` releases are deployed to the [BRGM nexus], they can be installed using:
```sh
pip install forgeo -i https://nexus.brgm.fr/repository/pypi-all/simple
```
Meanwhile one can build it manually from gitlab:
```bash
pip install git+https://gitlab.brgm.fr/brgm/geomodelling/forgeo/core
```
To locally build/install this package, use:
```sh
git clone https://gitlab.brgm.fr/brgm/geomodelling/forgeo/core
cd forgeo
# 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/
