Metadata-Version: 2.1
Name: akantu-geomechanical-solver
Version: 0.2.1
Summary: Geomechanical simulator based on the open-source FEM library Akantu.
Home-page: https://gitlab.com/emil.gallyamov/akantu-geomechanical-solver
License: GPL
Author: Emil Gallyamov
Author-email: emil.gallyamov@epfl.ch
Requires-Python: >=3.10,<4.0
Classifier: License :: Other/Proprietary License
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3.10
Classifier: Programming Language :: Python :: 3.11
Classifier: Programming Language :: Python :: 3.12
Provides-Extra: dev
Provides-Extra: doc
Provides-Extra: parallel
Provides-Extra: serial
Provides-Extra: test
Requires-Dist: akantu (==4.0.1rc2+226.gad188433212) ; extra == "serial"
Requires-Dist: gmsh (>=4.13.1,<5.0.0)
Requires-Dist: mpi4py (>=4.0.0,<5.0.0)
Requires-Dist: mpmath (>=1.3.0,<2.0.0) ; extra == "dev" or extra == "test"
Requires-Dist: numpy (>=2.0.0,<3.0.0)
Requires-Dist: pre-commit (>=3.8.0,<4.0.0) ; extra == "dev"
Requires-Dist: pytest (>=8.3.2,<9.0.0) ; extra == "dev" or extra == "test"
Requires-Dist: scipy (>=1.14.0,<2.0.0) ; extra == "dev" or extra == "test" or extra == "parallel"
Requires-Dist: sphinx (>=8.0.2,<9.0.0) ; extra == "doc" or extra == "dev"
Project-URL: Repository, https://gitlab.com/emil.gallyamov/akantu-geomechanical-solver
Description-Content-Type: text/markdown

# Akantu Geomechanica Solver

_Python package containing a geomechanical simulator based on the open-source FEM library [Akantu](https://gitlab.com/akantu/akantu)_

[![PyPI version](https://badge.fury.io/py/akantu-geomechanical-solver.svg)](https://badge.fury.io/py/akantu-geomechanical-solver)
[![Project Status](https://img.shields.io/badge/status-under%20development-yellow)](https://gitlab.com/emil.gallyamov/akantu-geomechanical-solver)
[![GitLab License](https://img.shields.io/gitlab/license/emil.gallyamov%2Fakantu-geomechanical-solver)](https://img.shields.io/gitlab/license/emil.gallyamov%2Fakantu-geomechanical-solver)

See the package documentation on [GitLab Pages](https://akantu-geomechanical-solver-hsolleder-7af331464042e47dbd537897e.gitlab.io/)

# Installation

## Serial

``` bash
pip install akantu-geomechanical-solver[serial] --index-url https://gitlab.com/api/v4/projects/15663046/packages/pypi/simple
```

## Parallel

### Pull the Docker image

To use the Docker image including a parallel version of the geomechanical solver, follow these steps:

1. Make sure you have Docker installed on your system.
2. Pull the Docker image from the registry using the following command:

```bash
docker pull registry.gitlab.com/emil.gallyamov/akantu-geomechanical-solver/parallel-gms-images:main
```

3. Once the image is pulled, you can run a container using the image with the following command:

```bash
docker run -it registry.gitlab.com/emil.gallyamov/akantu-geomechanical-solver/parallel-gms-images:main
```

This will start a container and give you an interactive shell inside it.

4. You can now use the Docker image for your desired purposes.

### Build from source

Start by cloning the repository, for instance using

```bash
git clone git@gitlab.com:emil.gallyamov/akantu-geomechanical-solver.git
```

Then, use the `installation.sh` script to setup the parallel version of Akantu hydromechanical coupling branch on your machine.

You can then install the parallel version version of the geomechanical solver

``` bash
pip install .[parallel]
```

