project

project#

Classes:

`GenerateIntermediateResultsSettings`	Settings for generating intermediate results for different job types in a project.
`Project`	Representation of a CryoSPARC Project, a container of data-processing results.
`ProjectLastAccessed`	Record for when a user last accessed a project.
`ProjectStats`	Statistics about the contents of a project.
`ProjectSymlink`	Information about a symlink in a project directory.
`ProjectWorkflowInfo`	Information about workflows used in a project.

class GenerateIntermediateResultsSettings#

Settings for generating intermediate results for different job types in a project.

Attributes:

`class_2D_new`
`class_3D`
`var_3D_disp`

class_2D_new: bool#

class_3D: bool#

var_3D_disp: bool#

class Project#

Representation of a CryoSPARC Project, a container of data-processing results.

Attributes:

`archived`
`autodump_errors`	List of error messages from the last automatic disk dump operation.
`autodump_failed`	Whether the last automatic disk dump operation failed.
`created_at`	When this object was first created.
`created_at_version`
`deleted`
`deleting`
`description`	User-specified detailed project description.
`detached`
`dumped_at`	When the model was last dumped to disk
`generate_intermediate_results_settings`
`id`
`import_status`
`imported_at`
`is_cleanup_in_progress`
`last_accessed`
`last_archived_version`
`last_detached_version`
`last_dumped_version`	The version of CryoSPARC last dumped at
`last_exp_group_id_used`	Last exposure group ID used in the project.
`owner_user_id`	User ID of the project owner.
`project_dir`	Absolute path to the project directory on disk.
`project_params_pdef`	Default job parameter definitions to be used within the project.
`project_stats`
`queue_paused`	Currently unused :meta private:
`size`	Size of the project on disk, in bytes.
`size_last_updated`
`starred_by`	List of user IDs who have starred the project.
`tags`
`title`	User-specified project title.
`uid`	Unique identifier for the project, e.g. "P1".
`uid_num`	Numeric part of the project UID.
`updated_at`	When this object was last modified.
`users_with_access`	List of user IDs with access to the project, including the owner.
`workflows`

archived: bool#

autodump_errors: List[str]#: List of error messages from the last automatic disk dump operation.

autodump_failed: bool#: Whether the last automatic disk dump operation failed.

created_at: datetime#: When this object was first created. Imported objects such as projects and jobs will retain the created time from their original CryoSPARC instance.

created_at_version: str#

deleted: bool#

deleting: bool#

description: str#: User-specified detailed project description.

detached: bool#

dumped_at: datetime | None#: When the model was last dumped to disk

generate_intermediate_results_settings: GenerateIntermediateResultsSettings#

id: str#

import_status: Literal['importing', 'complete', 'failed'] | None#

imported_at: datetime | None#

is_cleanup_in_progress: bool#

last_accessed: ProjectLastAccessed | None#

last_archived_version: str | None#

last_detached_version: str | None#

last_dumped_version: str | None#: The version of CryoSPARC last dumped at

last_exp_group_id_used: int | None#: Last exposure group ID used in the project.

owner_user_id: str#: User ID of the project owner.

project_dir: str#: Absolute path to the project directory on disk.

project_params_pdef: Dict[str, Any]#: Default job parameter definitions to be used within the project. For example {'output_f16': True} to enable half-precision output for all motion correction jobs.

project_stats: ProjectStats#

queue_paused: bool#: Currently unused :meta private:

size: int#: Size of the project on disk, in bytes.

size_last_updated: datetime#

starred_by: List[str]#: List of user IDs who have starred the project.

tags: List[str]#

title: str#: User-specified project title.

uid: str#: Unique identifier for the project, e.g. “P1”.

uid_num: int#: Numeric part of the project UID.

updated_at: datetime#: When this object was last modified.

users_with_access: List[str]#: List of user IDs with access to the project, including the owner.

workflows: ProjectWorkflowInfo | None#

class ProjectLastAccessed#

Record for when a user last accessed a project.

Attributes:

`accessed_at`	Timestamp of the last access.
`name`	Username that last accessed the project.

accessed_at: datetime#: Timestamp of the last access.

name: str#: Username that last accessed the project.

class ProjectStats#

Statistics about the contents of a project.

Attributes:

`job_count`
`job_sections`	Number of jobs per section.
`job_status`	Number of jobs per status.
`job_types`	Number of jobs per type.
`session_count`
`updated_at`
`workspace_count`

job_count: int#

job_sections: Dict[str, int]#: Number of jobs per section.

job_status: Dict[str, int]#: Number of jobs per status.

job_types: Dict[str, int]#: Number of jobs per type.

session_count: int#

updated_at: datetime | None#

workspace_count: int#

class ProjectSymlink#

Information about a symlink in a project directory.

Attributes:

`exists`	Whether the target of the symlink exists.
`path`	Path of the symlink.
`target`	Target of the symlink.

exists: bool#: Whether the target of the symlink exists.

path: str#: Path of the symlink.

target: str#: Target of the symlink.

class ProjectWorkflowInfo#

Information about workflows used in a project.

Attributes:

`latest_workflow_uid`	UID of the latest workflow applied in a project.
`runs`	Map from workflow ID to the number of runs of that workflow.

latest_workflow_uid: str#: UID of the latest workflow applied in a project.

runs: Dict[str, int]#: Map from workflow ID to the number of runs of that workflow.

project

Contents

project#