Skip to content

Latest commit

 

History

History
56 lines (41 loc) · 2.15 KB

README.md

File metadata and controls

56 lines (41 loc) · 2.15 KB
Raw

pyGMS

License: GPL v3 DOI Codacy Badge Codacy Badge

pyGMS is a Python 3 module designed to analyse the rheological behaviour of lithosphere-scale 3D structural models that were created with the GeoModellingSystem (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.

# Clone the repository
git clone git@github.com: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 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.

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)