cryosparc

Contents

cryosparc#

Functions:

get_include()

Get the include directory for the <cryosparc-tools/dataset.h> header file to access CryoSPARC dataset handles from other languages.

get_include()#

Get the include directory for the <cryosparc-tools/dataset.h> header file to access CryoSPARC dataset handles from other languages.

Returns:

Include path for C compilers.

Return type:

str

Modules

api

Python functions for programmatically controlling CryoSPARC.

auth

Functions and classes for performing and storing user authentication operations.

cli

constants

controllers

Core base classes and utilities for other cryosparc-tools modules.

dataset

Classes and utilities for loading, saving and working with .cs Dataset files.

errors

Definitions for various error classes raised by cryosparc-tools functions

json_util

model_registry

models

mrc

platform

registry

Model registration functions used by API client to determine how to interpret JSON responses.

search

spec

Specification for various utility types used throughout tools and CryoSPARC.

star

Helper module for reading and writing relion star files.

stream

Stream processing utilities

stream_registry

tools

Main module exporting the CryoSPARC class for interfacing with a CryoSPARC instance from Python

util