Welcome to parakeet’s documentation!

Contents:

• Installation
  • Dependencies
  • Environment variables
  • Python virtual environments
  • Install from source
  • Installation for developers
  • Install using PIP
  • Install using conda
  • Install as a Docker container
  • Install as a Singularity image
  • Install as Singularity sandbox
  • Build a derivative Singularity image
  • Install as a Apptainer image
  • Install as a snap
  • Install on Baskerville HPC (native)
  • Install on Baskerville (apptainer)
  • Install on STFC Scarf
  • Testing
• Command line programs
  • Config file manipulation programs
  • Sample manipulation programs
  • Image Simulation programs
  • Analysis programs
  • PDB file programs
  • Other programs
• Python API
  • Image IO functions
  • PDB file functions
  • Configuration functions
  • Sample functions
  • Image simulation functions
  • Analysis functions
  • Data models
• Configuration
  • Definitions
  • Examples
• Tutorial
  • Generate a new configuration file
  • Edit the configuration file
  • Generate sample model
  • Simulate EM images
  • Export functions
  • Analysis functions
• Publications

Indices and tables

• Index

• Module Index

• Search Page