Installation

Installing GemPy

The latest release version of GemPy is available via PyPi. To install the core version, simply use pip:

$ pip install gempy

This will install GemPy with the minimal required dependencies.

GemPy viewer

For visualization in 2-D and 3-D, the additional package gempy-viewer can be used and installed with:

$ pip install gempy-viewer

The 3-D visualization is based on pyvista. This package needs to be installed separately. Please check:

• PyVista: Installation guide available on the PyVista installation page.

Enhanced Installation Options

For additional features, GemPy offers enhanced installation options:

• Base Features: For the majority of functionalities, install with base dependencies:

  $ pip install gempy[base]
  

• Optional Features: To access optional features such as data download support, install with optional dependencies:

  $ pip install gempy[opt]
  

• Development Version: For development purposes, including testing tools:

  $ pip install gempy[dev]
  

Note: Some advanced functionalities in GemPy require PyTorch. For installation, please follow the instructions on the PyTorch installation page.

Manual Installation

For the latest, cutting-edge version of GemPy, you can clone the repository and install it manually:

1. Clone the repository:

   $ git clone https://github.com/cgre-aachen/gempy.git
   

2. Navigate to the root of the cloned repository and install using pip:

   $ pip install -e .
   

Dependencies

GemPy relies on numerous open-source libraries. Core dependencies are automatically installed with the package. Enhanced functionalities require additional dependencies, structured as follows:

• Core Dependencies: Installed with the basic package.

• Base Dependencies: Additional libraries for extended functionalities (base-requirements.txt).

• Optional Dependencies: Libraries for optional features (optional-requirements.txt).

• Development Dependencies: Tools needed for development (dev-requirements.txt).