Metadata-Version: 2.1
Name: python-multem
Version: 0.2.1
Summary: A Python wrapper for MULTEM
Home-page: https://github.com/rosalindfranklininstitute/python-multem
Author: James Parkhurst
Author-email: james.parkhurst@diamond.ac.uk
License: GPL v3
Project-URL: Source, https://github.com/rosalindfranklininstitute/python-multem
Project-URL: Tracker, https://github.com/rosalindfranklininstitute/python-multem/issues
Description: # python-multem
        > Python wrapper for MULTEM
        
        [![Language grade: Python](https://img.shields.io/lgtm/grade/python/g/rosalindfranklininstitute/python-multem.svg?logo=lgtm&logoWidth=18)](https://lgtm.com/projects/g/rosalindfranklininstitute/python-multem/context:python)
        [![Total alerts](https://img.shields.io/lgtm/alerts/g/rosalindfranklininstitute/python-multem.svg?logo=lgtm&logoWidth=18)](https://lgtm.com/projects/g/rosalindfranklininstitute/python-multem/alerts/)
        [![Building](https://github.com/rosalindfranklininstitute/python-multem/actions/workflows/python-package.yml/badge.svg)](https://github.com/rosalindfranklininstitute/python-multem/actions/workflows/python-package.yml)
        [![Publishing](https://github.com/rosalindfranklininstitute/python-multem/actions/workflows/python-publish.yml/badge.svg)](https://github.com/rosalindfranklininstitute/python-multem/actions/workflows/python-publish.yml)
        
        ## Installation
        
        To install from the github repository do the following
        
        ```sh
        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 and then do the following:
        
        ```sh
        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:
        
        ```sh
        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:
        
        ```sh
        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:
        
        ```sh
        pytest
        ```
        
        ## Issues
        
        Please use the [GitHub issue tracker](https://github.com/rosalindfranklininstitute/python-multem/issues) 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.
        
        
Keywords: MULTEM
Platform: unix
Platform: linux
Platform: osx
Platform: cygwin
Platform: win32
Classifier: Development Status :: 4 - Beta
Classifier: Intended Audience :: Developers
Classifier: License :: OSI Approved :: BSD License
Classifier: Operating System :: POSIX
Classifier: Operating System :: Microsoft :: Windows
Classifier: Operating System :: MacOS :: MacOS X
Classifier: Topic :: Utilities
Classifier: Programming Language :: Python :: 3.4
Classifier: Programming Language :: Python :: 3.5
Classifier: Programming Language :: Python :: 3.6
Classifier: Programming Language :: Python :: 3.7
Description-Content-Type: text/markdown
Provides-Extra: build_sphinx
Provides-Extra: test
