Installation

PyKonal has been tested with Python >=3.7 on Linux (Ubuntu 20.04LTS, 19.10, 18.04LTS) and Mac OS X (10.13) operating systems. It should run on Windows but is untested.

Installation is via a setup.py file and requires numpy and Cython to be installed prior to building. Conda is recommended for managing Python environments and dependencies.

Dependencies

• cython [>=0.29.14]

• h5py

• numpy

• scipy

Conda (Recommended)

sh$> conda create --name pykonal -c conda-forge python=3.8 'cython>=0.29.14' h5py numpy scipy
sh$> conda activate pykonal
sh$> cd path/to/pykonal
sh$> pip install .

pip

sh$> pip install cython>=0.29.14 h5py numpy scipy
sh$> cd path/to/pykonal
sh$> pip install .

Note

The first impulse of many users at this point is to check that the module imports properly. Make sure you exit the package directory before opening your Python interpreter, otherwise you will receive a ModuleNotFoundError.