Installation

Use pip,

$ pip install pymks

and then run the tests.

$ python -c "import pymks; pymks.test()"

Scipy Stack

The packages Nosetests, Scipy, Numpy, and Scikit-learn are all required.

Examples

To use the interactive examples from the notebooks/ directory, IPython and Matplotlib are both required.

SfePy

PyMKS can be used without SfePy, but many of the tests and examples require SfePy to generate the sample data so it is a good idea to install it.

To install SfePy, first clone with

$ git clone git://github.com/sfepy/sfepy.git

and then install with

$ cd sfepy
$ python setup.py install

See the SfePy installation instructions for more details.

PyFFTW

If installed, PyMKS will use PyFFTW to computed FFTs instead of Numpy. As long as Numpy is not using Intel MKL, PyFFTW should improvement the performance of PyMKS.

To install PyFFTW use pip

$ pip install pyfftw

See the PyFFTW installation instructions for more details.

Installation on Windows

We recommend you download and install Anaconda Python Distribution for Python 2.7 and then download and install PyMKS using the windows installer.

Installation with Anaconda

The Anaconda Python Distributionn contains all of the required packages outside of SfePy and works on multiple platforms. Download and install Anaconda, and use the Anaconda Command Prompt to install PyMKS using pip.

Requirements

The REQUIREMENTS.md file has a list of required packages in a Python environment used to run tests and examples for the current release of PyMKS.

Installation Issues

Please send questions and issues about installation of PyMKS to the pymks-general@googlegroups.com list.