scheduler_target

Classes:

Cluster	Cluster-type scheduler targets details
Node	Node-type scheduler target that may include GPUs
SchedulerTarget	Details and configuration for a node or cluster target.
SchedulerTargetCluster
SchedulerTargetNode

class Cluster

Cluster-type scheduler targets details

Attributes:

custom_var_names	Computed list if custom variable names defined in the template
custom_vars	Custom variable values
qdel_cmd_tpl	Template command to delete cluster jobs.
qinfo_cmd_tpl	Template command to check cluster queue info.
qstat_cmd_tpl	Template command to check the cluster job by its ID.
qsub_cmd_tpl	Template command to submit jobs to the cluster.
script_tpl	Full cluster submission script Jinja template.
send_cmd_tpl	Template command to access the cluster and running commands.
tpl_vars	List of template variable names in a cluster target
type	Cluster scheduler targets have type "cluster".

custom_var_names: List[str]

Computed list if custom variable names defined in the template

custom_vars: Dict[str, str]

Custom variable values

qdel_cmd_tpl: str

Template command to delete cluster jobs.

qinfo_cmd_tpl: str

Template command to check cluster queue info.

qstat_cmd_tpl: str

Template command to check the cluster job by its ID.

qsub_cmd_tpl: str

Template command to submit jobs to the cluster.

script_tpl: str

Full cluster submission script Jinja template.

send_cmd_tpl: str

Template command to access the cluster and running commands.

tpl_vars: List[str]

List of template variable names in a cluster target

type: Literal['cluster']

Cluster scheduler targets have type “cluster”.

class Node

Node-type scheduler target that may include GPUs

Attributes:

gpus	Details for all GPUs available on this node, including those excluded from resource_slots.
monitor_port	Not used.
resource_fixed	Available fixed resources.
resource_slots	Available compute resources.
ssh_str	Shell command used to access this node, e.g., ssh cryosparcuser@worker.
type	Node scheduler targets have type "node".

gpus: List[Gpu] | None

Details for all GPUs available on this node, including those excluded from resource_slots.

monitor_port: int | None

Not used.

resource_fixed: FixedResourceSlots

Available fixed resources.

resource_slots: ResourceSlots

Available compute resources.

ssh_str: str

Shell command used to access this node, e.g., ssh cryosparcuser@worker.

type: Literal['node']

Node scheduler targets have type “node”.

class SchedulerTarget

Details and configuration for a node or cluster target.

Attributes:

cache_path	Path the SSD cache scratch directory, if applicable.
cache_quota_mb	Do not cache more than this amount on the SSD scrath drive..
cache_reserve_mb	Ensure at least this much space is free on the SSD scratch drive before caching.
config	Target configuration details.
desc	Human-readable description for this target.
hostname	Network machine hostname (same as name for for clusters).
lane	Lane name this target belongs to.
name	Identifier for this target.
title	Human-readable title for this target.
worker_bin_path	Path to cryosparc_worker/bin/cryosparcw executable.

cache_path: str | None

Path the SSD cache scratch directory, if applicable.

cache_quota_mb: int | None

Do not cache more than this amount on the SSD scrath drive..

cache_reserve_mb: int | None

Ensure at least this much space is free on the SSD scratch drive before caching.

config: Node | Cluster

Target configuration details.

desc: str | None

Human-readable description for this target.

hostname: str

Network machine hostname (same as name for for clusters).

lane: str

Lane name this target belongs to.

name: str

Identifier for this target.

title: str

Human-readable title for this target.

worker_bin_path: str

Path to cryosparc_worker/bin/cryosparcw executable.

class SchedulerTargetCluster

Attributes:

cache_path	Path the SSD cache scratch directory, if applicable.
cache_quota_mb	Do not cache more than this amount on the SSD scrath drive..
cache_reserve_mb	Ensure at least this much space is free on the SSD scratch drive before caching.
config	Target configuration details.
desc	Human-readable description for this target.
hostname	Network machine hostname (same as name for for clusters).
lane	Lane name this target belongs to.
name	Identifier for this target.
title	Human-readable title for this target.
worker_bin_path	Path to cryosparc_worker/bin/cryosparcw executable.

cache_path: str | None

Path the SSD cache scratch directory, if applicable.

cache_quota_mb: int | None

Do not cache more than this amount on the SSD scrath drive..

cache_reserve_mb: int | None

Ensure at least this much space is free on the SSD scratch drive before caching.

config: Cluster

Target configuration details.

desc: str | None

Human-readable description for this target.

hostname: str

Network machine hostname (same as name for for clusters).

lane: str

Lane name this target belongs to.

name: str

Identifier for this target.

title: str

Human-readable title for this target.

worker_bin_path: str

Path to cryosparc_worker/bin/cryosparcw executable.

class SchedulerTargetNode

Attributes:

cache_path	Path the SSD cache scratch directory, if applicable.
cache_quota_mb	Do not cache more than this amount on the SSD scrath drive..
cache_reserve_mb	Ensure at least this much space is free on the SSD scratch drive before caching.
config	Target configuration details.
desc	Human-readable description for this target.
hostname	Network machine hostname (same as name for for clusters).
lane	Lane name this target belongs to.
name	Identifier for this target.
title	Human-readable title for this target.
worker_bin_path	Path to cryosparc_worker/bin/cryosparcw executable.

cache_path: str | None

Path the SSD cache scratch directory, if applicable.

cache_quota_mb: int | None

Do not cache more than this amount on the SSD scrath drive..

cache_reserve_mb: int | None

Ensure at least this much space is free on the SSD scratch drive before caching.

config: Node

Target configuration details.

desc: str | None

Human-readable description for this target.

hostname: str

Network machine hostname (same as name for for clusters).

lane: str

Lane name this target belongs to.

name: str

Identifier for this target.

title: str

Human-readable title for this target.

worker_bin_path: str

Path to cryosparc_worker/bin/cryosparcw executable.