python-multem


Namepython-multem JSON
Version 0.4.0 PyPI version JSON
download
home_pagehttps://github.com/rosalindfranklininstitute/python-multem
SummaryA Python wrapper for MULTEM
upload_time2025-01-21 11:59:14
maintainerNone
docs_urlNone
authorJames Parkhurst
requires_pythonNone
licenseGPL v3
keywords multem
VCS
bugtrack_url
requirements setuptools cmake ninja wheel pytest pytest-cov mock
Travis-CI No Travis.
coveralls test coverage No coveralls.
            # 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)
[![DOI](https://zenodo.org/badge/201027691.svg)](https://zenodo.org/badge/latestdoi/201027691)

## 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. The repository has a submodule
for pybind11 so after cloning the repository run

```sh
git submodule update --init --recursive
```

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.


            

Raw data

            {
    "_id": null,
    "home_page": "https://github.com/rosalindfranklininstitute/python-multem",
    "name": "python-multem",
    "maintainer": null,
    "docs_url": null,
    "requires_python": null,
    "maintainer_email": null,
    "keywords": "MULTEM",
    "author": "James Parkhurst",
    "author_email": "james.parkhurst@diamond.ac.uk",
    "download_url": "https://files.pythonhosted.org/packages/c5/16/8b1ec2e9c2ba0707bb243bf83f1e68818c5f9de0e45da1d84af7b80d764e/python_multem-0.4.0.tar.gz",
    "platform": "unix",
    "description": "# python-multem\n> Python wrapper for MULTEM\n\n[![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)\n[![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/)\n[![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)\n[![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)\n[![DOI](https://zenodo.org/badge/201027691.svg)](https://zenodo.org/badge/latestdoi/201027691)\n\n## Installation\n\nTo install from the github repository do the following\n\n```sh\nexport CUDACXX=${PATH_TO_CUDA}/bin/nvcc\npython -m pip install git+https://github.com/rosalindfranklininstitute/python-multem.git@master\n```\n\nTo install from source, clone this repository. The repository has a submodule\nfor pybind11 so after cloning the repository run\n\n```sh\ngit submodule update --init --recursive\n```\n\nThen do the following:\n\n```sh\nexport CUDACXX=${PATH_TO_CUDA}/bin/nvcc\npython -m pip install .\n```\n\nIf you would like to run the tests then, clone this repository and then do the following:\n\n```sh\nexport CUDACXX=${PATH_TO_CUDA}/bin/nvcc\npython -m pip install .[test]\n```\n\n## Installation for developers\n\nTo install for development, clone this repository and then do the following:\n\n```sh\nexport CUDACXX=${PATH_TO_CUDA}/bin/nvcc\npython -m pip install -e .\n```\n\n## Testing\n\nTo run the tests, follow the installation instructions and execute the following:\n\n```sh\npytest\n```\n\n## Issues\n\nPlease use the [GitHub issue tracker](https://github.com/rosalindfranklininstitute/python-multem/issues) to submit bugs or request features.\n\n## License\n\nCopyright Diamond Light Source, 2019.\n\nDistributed under the terms of the GPLv3 license, python-multem is free and open source software.\n\n",
    "bugtrack_url": null,
    "license": "GPL v3",
    "summary": "A Python wrapper for MULTEM",
    "version": "0.4.0",
    "project_urls": {
        "Homepage": "https://github.com/rosalindfranklininstitute/python-multem",
        "Source": "https://github.com/rosalindfranklininstitute/python-multem",
        "Tracker": "https://github.com/rosalindfranklininstitute/python-multem/issues"
    },
    "split_keywords": [
        "multem"
    ],
    "urls": [
        {
            "comment_text": "",
            "digests": {
                "blake2b_256": "c5168b1ec2e9c2ba0707bb243bf83f1e68818c5f9de0e45da1d84af7b80d764e",
                "md5": "54a966e47c4e6e25a6c83012c07834bb",
                "sha256": "b3ca77ca43abdbe55dbfec7c18f9fd52913c64d1c4f5364ebcf5f372bf9f0f94"
            },
            "downloads": -1,
            "filename": "python_multem-0.4.0.tar.gz",
            "has_sig": false,
            "md5_digest": "54a966e47c4e6e25a6c83012c07834bb",
            "packagetype": "sdist",
            "python_version": "source",
            "requires_python": null,
            "size": 88259976,
            "upload_time": "2025-01-21T11:59:14",
            "upload_time_iso_8601": "2025-01-21T11:59:14.991001Z",
            "url": "https://files.pythonhosted.org/packages/c5/16/8b1ec2e9c2ba0707bb243bf83f1e68818c5f9de0e45da1d84af7b80d764e/python_multem-0.4.0.tar.gz",
            "yanked": false,
            "yanked_reason": null
        }
    ],
    "upload_time": "2025-01-21 11:59:14",
    "github": true,
    "gitlab": false,
    "bitbucket": false,
    "codeberg": false,
    "github_user": "rosalindfranklininstitute",
    "github_project": "python-multem",
    "travis_ci": false,
    "coveralls": false,
    "github_actions": true,
    "requirements": [
        {
            "name": "setuptools",
            "specs": []
        },
        {
            "name": "cmake",
            "specs": []
        },
        {
            "name": "ninja",
            "specs": []
        },
        {
            "name": "wheel",
            "specs": []
        },
        {
            "name": "pytest",
            "specs": []
        },
        {
            "name": "pytest-cov",
            "specs": []
        },
        {
            "name": "mock",
            "specs": []
        }
    ],
    "lcname": "python-multem"
}
        
Elapsed time: 0.47143s