Parakeet is a digital twin for cryo electron tomography and stands for Program for Analysis and Reconstruction of Artificial data for Kryo ElEctron Tomography
Installation
Parakeet can be installed using pip with the following command:
pip install python-parakeet
NOTE: Because the package needs to be built locally from source and has some external dependencies you may need to ensure your environment is ready before running this command. You need to set the location of the CUDA compiler and possibly G++ and FFTW libraries. For full instructions please see the installation documentation here.
Usage
Parakeet can be used as a suite of command line tools as follows:
parakeet.config.new -c config.yaml
parakeet.sample.new -c config.yaml
parakeet.sample.add_molecules -c config.yaml
parakeet.simulate.exit_wave -c config.yaml
parakeet.simulate.optics -c config.yaml
parakeet.simulate.image -c config.yaml
For full command line usage instructions please see the command line documentation here here. Alternatively, there is a complementary high level Python API which can be seen here.
Documentation
Checkout the documentation for more information!
Notifications
You can receive notifications from the Github discussions by clicking "watch" on this repository.
Issues
Please use the GitHub issue tracker to submit bugs or request features.
Changes
Checkout the changelog for a list of recent changes to parakeet.
Contributions
If you would like to help contribute to profet, please read our contribution guide and code of conduct.
License
Copyright Diamond Light Source and Rosalind Franklin Institute, 2019.
Distributed under the terms of the GPLv3 license, parakeet is free and open source software.
1 maintainer
Metadata
1 maintainer
Release files for python-parakeet 0.6.8
For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.
Source distribution (sdist)
| File | Size | Uploaded | |
|---|---|---|---|
| python_parakeet-0.6.8.tar.gz | 9.3 MB | Details |
Release files / python_parakeet-0.6.8.tar.gz
| Download URL | python_parakeet-0.6.8.tar.gz |
|---|---|
| Size | 9.3 MB |
| Tags | Source |
|
SHA-256 checksum How to use checksums |
1f609c3f6b955ef969be90cffb7bec23747a706cb8cce65511e7fcde3ac4a5a4
|
|
BLAKE2b-256 checksum How to use checksums |
672899d506ade3b03e24c68f96ef83eac1ac2d2fb3faf654978ed7f19db59f4f
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
Yes |
| Uploaded via |
twine/6.1.0 CPython/3.12.9
|
Provenance
Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.
PyPI Publish Attestation
PyPI verified that this artifact, at this checksum, originated from the publisher listed below.
Signed by GitHub Actions, verified by PyPI on Aug 8, 2025.
Transparency log
