Metadata-Version: 2.1
Name: scikit-mps
Version: 0.3.1
Summary: Multiple point statistical (MPS) simulation
Home-page: https://github.com/ergosimulation/mpslib/scikit-mps
Download-URL: https://github.com/cultpenguin/scikit-mps/master.zip
Author: Thomas Mejer Hansen
Author-email: thomas.mejer.hansen@gmail.com
License: LGPL
Keywords: geostatistics,simulation,MPS
Platform: UNKNOWN
Description-Content-Type: text/x-rst
License-File: LICENSE
Requires-Dist: numpy (>=1.0.2)
Requires-Dist: matplotlib (>=1.0.0)

scikit-mps: A python interface to MPSlib 
========================================================================================


.. image:: https://img.shields.io/pypi/v/scikit-mps.svg?style=flat-square
    :target: https://pypi.org/project/scikit-mps

.. image:: https://img.shields.io/pypi/pyversions/scikit-mps.svg?style=flat-square
    :target: https://pypi.org/project/scikit-mps

.. image:: https://img.shields.io/badge/license-MIT-blue.svg?style=flat-square
    :target: https://en.wikipedia.org/wiki/MIT_License


.. image:: https://colab.research.google.com/assets/colab-badge.svg
    :target: https://colab.research.google.com/github/ergosimulation/mpslib/blob/master/scikit-mps/examples/mpslib_in_google_colab.ipynb


`scikit-mps` is a Python interface to MPSlib, https://github.com/ergosimulation/mpslib/,
which is a C++ library for geostatistical multiple point simulation, with implementations
of 'SNESIM', 'ENESIM', and 'GENESIM'

It contains three modules:
  * mpslib: Interacts with MPSlib
  * eas: read and write EAS/GSLIB formatted files
  * trainingimages: Access to a number of trainingimages

.. code::

   import mpslib as mps
   O=mps.mpslib(method='mps_snesim_tree')
   O.run()
   O.plot_reals()
   O.plot_etype()

PyPI
~~~~~~~~~
`<http://pypi.python.org/pypi/scikit-mps>`

Requirements
~~~~~~~~~~~~
* Numpy >= 1.0.2
* Matplotlib >= 1.0.2
* MPSlib needs to be downloaded, installed, and in the system path (https://github.com/ergosimulation/mpslib/)
  [Any 11 C++11 compiler should work, such as gcc, MinGW, MSVC]

Installing
~~~~~~~~~~~~~~
* Via pip: pip3 install scikit-mps

.. code::

   cd ROOT_OF_MPSLIB/python   
   pip3 install .

If you wish to develop the scikit-mps package, then install it in editable developer mode using

.. code::

    pip3 install -e .



