Skip to content

Latest commit

 

History

History
113 lines (71 loc) · 3.21 KB

INSTALLATION.md

File metadata and controls

113 lines (71 loc) · 3.21 KB

Installation

Conda

Conda is the easiest way to install PyMKS. To install use

$ conda config --add channels pymks
$ conda install pymks

Pip

The following steps outline the necessary requirements for a successful installation of PyMKS.

Use pip,

$ pip install pymks

and then run the tests.

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

Scipy Stack

Both Scipy and Numpy as well as Scikit-learn are required.

Testing

The package Pytest is required for testing only. Use

$ py.test

in the base directory or

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

to run all the tests.

Examples

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

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.

If installed, PyMKS will use PyFFTW to compute FFTs instead of Numpy. As long as Numpy is not using Intel MKL, PyFFTW should improve 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 the Anaconda Python Distribution for Python 2.7 (x64) and then download and install PyMKS, using the windows installer.

Installation on Mac OS X

We recommend you download and install the Anaconda Python Distribution for Python 2.7 (x64). Once Anaconda has been installed, follow the above procedures to install SfePy. Finally, install PyMKS using pip as described above.

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 your terminal or shell 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.