A phantom generator
Project description
Parakeet :parrot:
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
However, 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. 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!
Issues
Please use the GitHub issue tracker to submit bugs or request features.
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.
Project details
Release history Release notifications | RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.