Skip to content

Latest commit

 

History

History
115 lines (80 loc) · 6.08 KB

README.md

File metadata and controls

115 lines (80 loc) · 6.08 KB
Raw

GEONE

Documentation Status

GEONE is a Python3 package providing a set of tools for geostatistical modeling, including:

  • multiple-point statistics (MPS) simulation as "DEESSE wrapper"
  • geostatistical tools based on two-point statistics, including "GEOSCLASSIC wrapper"
  • miscellaneous algorithms based on random processes

Documentation, examples and references

The documentation of GEONE is on https://geone.readthedocs.io.

The notebooks (examples) from the documentation are available in docs/source/notebooks.

Installation

GEONE relies on pre-compiled C libraries (DEESSE and GEOSCLASSIC core)

GEONE is available:

  • on PyPI (The Python Package Index), for:
    • linux (x86_64 with GLIBC 2.35 or GLIBC 2.27) and python 3.9 to 3.12
    • mac (x86_64 or arm64) and python 3.9 to 3.12
    • windows and python 3.9 to 3.12
  • on the Github repository, for:
    • linux (x86_64 with GLIBC 2.35 or GLIBC 2.27) and python 3.7 to 3.12
    • mac (x86_64 or arm64) and python 3.8 to 3.12
    • windows and python 3.7 to 3.12

Installation from PyPI

In a terminal type

pip install geone

Or, equivalently: python -m pip install geone.

Installation from the Github repository

In a terminal, change directory where to download GEONE, and type

git clone https://github.com/randlab/geone.git
cd geone
pip install .

Note: use pip install . --verbose or pip install . -v for printing (more) messages during the installation.

Alternatively:

  • Instead of git clone ..., you can download GEONE from the Github repository: click on the green button "code" and choose "Download ZIP".
  • Then, unzip the archive on your computer
  • Finally, in a terminal, go into the unzipped directory, and type pip install .

Warning - Using GEONE

If the installation has been done from github, do not launch python from the directory containing the downloaded sources and where the installation has been done (with pip), otherwise import geone will fail.

Requirements

The following python packages are used by GEONE (tested on python 3.11.5):

  • matplotlib (3.8.1)
  • multiprocessing (for parallel processes)
  • numpy (tested with version 1.26.0)
  • pandas (tested with version 2.1.2)
  • pyvista (tested with version 0.42.3)
  • scipy (tested with version 1.11.3)

Warning

numpy version less than 2. is required

Removing GEONE

In a terminal type

pip uninstall -y geone

Note: First remove the directory 'geone.egg-info' from the current directory (if present).

License

See LICENSE file.

Authors

GEONE is developed by Julien Straubhaar and Philippe Renard.