Skip to main content

3D CTF correction

Project description

guanaco

Python library for doing 3D CTF correction

Code style: black Language grade: Python Total alerts Building Publishing DOI

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

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

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 for developers and then do the following:

pytest

Usage

To do a tomographic reconstruction with no CTF correction do something do the following

guanaco -i images.mrc -o rec.mrc -d gpu

To correct all images with the same single defocus something do the following

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

guanaco -i images.mrc -o rec.mrc -d gpu --df=20000 --Cs=2.7 --ndf=10

Issues

Please use the GitHub issue tracker 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.

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

guanaco-0.3.2.tar.gz (825.5 kB view details)

Uploaded Source

File details

Details for the file guanaco-0.3.2.tar.gz.

File metadata

  • Download URL: guanaco-0.3.2.tar.gz
  • Upload date:
  • Size: 825.5 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/5.1.0 CPython/3.12.5

File hashes

Hashes for guanaco-0.3.2.tar.gz
Algorithm Hash digest
SHA256 2b2c778e7d72600eaeb3187c2398704fd6ce4466c66f1b558247e031220aab7f
MD5 cfe8cc023bd5c092a82461c2b66fccc8
BLAKE2b-256 b5fdabb6742085c99645ce18c558362e98552bdb88d32fbc7b0e9008142e5d49

See more details on using hashes here.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page