# guanaco
> Python library for doing 3D CTF correction
[](https://github.com/psf/black)
[](https://lgtm.com/projects/g/jmp1985/guanaco/context:python)
[](https://lgtm.com/projects/g/jmp1985/guanaco/alerts/)
[](https://github.com/rosalindfranklininstitute/guanaco/actions/workflows/python-package.yml)
[](https://github.com/rosalindfranklininstitute/guanaco/actions/workflows/python-publish.yml)
[](https://zenodo.org/badge/latestdoi/337997172)
## Installation
In order to build this package, the following dependencies are required:
- The CUDA toolkit
- FFTW
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/guanaco.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 for developers and then do the following:
```sh
pytest
```
## Usage
To do a tomographic reconstruction with no CTF correction do something do the following
```sh
guanaco -i images.mrc -o rec.mrc -d gpu
```
To correct all images with the same single defocus something do the following
```sh
guanaco -i images.mrc -o rec.mrc -d gpu --df=20000 --Cs=2.7
```
To correct all images with the same defocus range something do the following
```sh
guanaco -i images.mrc -o rec.mrc -d gpu --df=20000 --Cs=2.7 --ndf=10
```
## Issues
Please use the [GitHub issue tracker](https://github.com/rosalindfranklininstitute/guanaco/issues) to submit bugs or request features.
## License
Copyright Diamond Light Source and Rosalind Franklin Institute, 2021
Distributed under the terms of the GPLv3 license, guanaco is free and open source software.
Raw data
{
"_id": null,
"home_page": "https://github.com/rosalindfranklininstitute/guanaco",
"name": "guanaco",
"maintainer": "",
"docs_url": null,
"requires_python": "",
"maintainer_email": "",
"keywords": "MULTEM",
"author": "James Parkhurst",
"author_email": "james.parkhurst@diamond.ac.uk",
"download_url": "https://files.pythonhosted.org/packages/f8/2d/f1e2164fdd5f7409fa2b8b6a794af39072bd19a37ba2f2a09565da68d313/guanaco-0.3.1.tar.gz",
"platform": "unix",
"description": "# guanaco\n> Python library for doing 3D CTF correction\n\n[](https://github.com/psf/black)\n[](https://lgtm.com/projects/g/jmp1985/guanaco/context:python)\n[](https://lgtm.com/projects/g/jmp1985/guanaco/alerts/)\n[](https://github.com/rosalindfranklininstitute/guanaco/actions/workflows/python-package.yml)\n[](https://github.com/rosalindfranklininstitute/guanaco/actions/workflows/python-publish.yml)\n[](https://zenodo.org/badge/latestdoi/337997172)\n\n## Installation\n\nIn order to build this package, the following dependencies are required:\n\n- The CUDA toolkit\n- FFTW\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/guanaco.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 for developers and then do the following:\n\n```sh\npytest\n```\n\n## Usage\n\nTo do a tomographic reconstruction with no CTF correction do something do the following\n\n```sh\nguanaco -i images.mrc -o rec.mrc -d gpu\n```\n\nTo correct all images with the same single defocus something do the following\n\n```sh\nguanaco -i images.mrc -o rec.mrc -d gpu --df=20000 --Cs=2.7\n```\n\nTo correct all images with the same defocus range something do the following\n\n```sh\nguanaco -i images.mrc -o rec.mrc -d gpu --df=20000 --Cs=2.7 --ndf=10\n```\n\n## Issues\n\nPlease use the [GitHub issue tracker](https://github.com/rosalindfranklininstitute/guanaco/issues) to submit bugs or request features.\n\n## License\n\nCopyright Diamond Light Source and Rosalind Franklin Institute, 2021\n\nDistributed under the terms of the GPLv3 license, guanaco is free and open source software.\n\n",
"bugtrack_url": null,
"license": "GPL v3",
"summary": "3D CTF correction",
"version": "0.3.1",
"project_urls": {
"Homepage": "https://github.com/rosalindfranklininstitute/guanaco",
"Source": "https://github.com/rosalindfranklininstitute/guanaco",
"Tracker": "https://github.com/rosalindfranklininstitute/guanaco/issues"
},
"split_keywords": [
"multem"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "f82df1e2164fdd5f7409fa2b8b6a794af39072bd19a37ba2f2a09565da68d313",
"md5": "ca0be0feb5c539824776964ea80affe7",
"sha256": "902663c9d334ce6a94e35b783b7accc64e3c4744e335731bd7a6c5d19718b49a"
},
"downloads": -1,
"filename": "guanaco-0.3.1.tar.gz",
"has_sig": false,
"md5_digest": "ca0be0feb5c539824776964ea80affe7",
"packagetype": "sdist",
"python_version": "source",
"requires_python": null,
"size": 825397,
"upload_time": "2024-01-25T10:49:01",
"upload_time_iso_8601": "2024-01-25T10:49:01.486525Z",
"url": "https://files.pythonhosted.org/packages/f8/2d/f1e2164fdd5f7409fa2b8b6a794af39072bd19a37ba2f2a09565da68d313/guanaco-0.3.1.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-01-25 10:49:01",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "rosalindfranklininstitute",
"github_project": "guanaco",
"travis_ci": false,
"coveralls": false,
"github_actions": true,
"requirements": [],
"lcname": "guanaco"
}
JSON
