python-multem

Python wrapper for MULTEM

Installation

To install from the github repository do the following

export CUDACXX=${PATH_TO_CUDA}/bin/nvcc
python -m pip install git+https://github.com/rosalindfranklininstitute/python-multem.git@master

To install from source, clone this repository. The repository has a submodule for pybind11 so after cloning the repository run

git submodule update --init --recursive

Then do the following:

export CUDACXX=${PATH_TO_CUDA}/bin/nvcc
python -m pip install .

If you would like to run the tests then, clone this repository and then do the following:

export CUDACXX=${PATH_TO_CUDA}/bin/nvcc
python -m pip install .[test]

Installation for developers

To install for development, clone this repository and then do the following:

export CUDACXX=${PATH_TO_CUDA}/bin/nvcc
python -m pip install -e .

Testing

To run the tests, follow the installation instructions and execute the following:

pytest

Issues

Please use the GitHub issue tracker to submit bugs or request features.

License

Copyright Diamond Light Source, 2019.

Distributed under the terms of the GPLv3 license, python-multem is free and open source software.