https://github.com/cmeessen/pygms
pyGMS: lithosphere-scale rheological analyses of GMS models in Python
https://github.com/cmeessen/pygms
geology geophysics lithosphere-strength rheology
Last synced: about 2 months ago
JSON representation
pyGMS: lithosphere-scale rheological analyses of GMS models in Python
- Host: GitHub
- URL: https://github.com/cmeessen/pygms
- Owner: cmeessen
- License: gpl-3.0
- Created: 2019-06-28T08:41:05.000Z (almost 6 years ago)
- Default Branch: master
- Last Pushed: 2019-10-08T12:27:19.000Z (over 5 years ago)
- Last Synced: 2025-04-17T04:18:50.688Z (2 months ago)
- Topics: geology, geophysics, lithosphere-strength, rheology
- Language: Python
- Homepage: https://cmeessen.github.io/pyGMS
- Size: 7.45 MB
- Stars: 3
- Watchers: 0
- Forks: 3
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG
- License: LICENSE
Awesome Lists containing this project
README
# pyGMS
[](https://www.gnu.org/licenses/gpl-3.0)
[](https://zenodo.org/badge/latestdoi/194238991)
[](https://www.codacy.com?utm_source=github.com&utm_medium=referral&utm_content=cmeessen/pyGMS&utm_campaign=Badge_Grade)
[](https://www.codacy.com?utm_source=github.com&utm_medium=referral&utm_content=cmeessen/pyGMS&utm_campaign=Badge_Coverage)
`pyGMS` is a Python 3 module designed to analyse the rheological behaviour of
lithosphere-scale 3D structural models that were created with the
[GeoModellingSystem](https://www.gfz-potsdam.de/en/section/basin-modeling/infrastructure/gms/)
(GMS, GFZ Potsdam). `pyGMS` was originally written for the
purpose of plotting yield strength envelope cross sections for my PhD thesis.
## Installation
This is a short version of the installation instructions. For a more detailed
version visit the
[documentation](https://cmeessen.github.io/pyGMS/installation.html).
```bash
# Clone the repository
git clone [email protected]:cmeessen/pyGMS.git
# Create an Anaconda environment
cd pyGMS
conda env create -f environment.yml
# Install with pip
conda activate pygms
pip install -e .
# Install some dependencies to be able to see the kernel in Jupyter notebooks
conda install -c conda-forge nb_conda_kernels
```
## Documentation
Please have a look at the
[documentation](https://cmeessen.github.io/pyGMS/index.html) for information
on how to install and use pyGMS.
## Contributing
If you find bugs, have a feature wish or a pull request, please open an
[issue](https://github.com/cmeessen/pyGMS/issues).
### Preparing a pull request
Before preparing a pull request make sure to
- comment the code
- update CHANGELOG
- check code style (`make pycodestyle`)
- add a test if the contribution adds a new feature or fixes a bug
- update the documentation (`cd docs/sphinx && make html && make gh-pages`)
- run `make coverage` (maintainers only)