Spruce subset within cube

A Cube that subsets components in a designunit based on distance to other components.

Main Parameters

Parameter Name Associated Port Port Type
Within distance    
Component(s) to subset    
Within Components    

Calculation Parameters

  • CPUs (integer) : The number of CPUs to run this cube with
    Default: 1 Min: 1 Max: 128
  • Cube Metrics (string) : Set of metrics to be collected

    Choices: cpu, disk, memory, network
  • Temporary Disk Space (MiB) (decimal) : The minimum amount of disk space in MiB (1048576 B) this cube requires. Due to overhead, request a couple hundred MiB more than required.
    Default: 5120.0 Min: 128.0 Max: 8589934592
  • Within distance (decimal) : The within distance in angstroms.
    Default: 5.0
  • GPUs (integer) : The number of GPUs to run this cube with
    Default: 0 Max: 16
  • Instance Tags (string) : Only run on machines with matching tags (comma separated)
    Default: “”
  • Instance Type (string) : The type of instance that this cube needs to be run on
  • Max Rotors (integer) : Cutoff of rotatable bonds. The cube will skip molecules with rotors more than the cutoff.
    Default: 20 Min: 1 Max: 9999
  • Memory (MiB) (decimal) : The minimum amount of memory in MiBs (1048576 B) this cube requires. Due to overhead, request a couple hundred MiB more than required.
    Default: 1800 Min: 256.0 Max: 8589934592
  • Metric Period (decimal) : How often to sample metrics, in seconds
    Default: 60 Min: 1 Max: 300
  • Spot policy (string) : Control cube placement on spot market instances
    Default: Prohibited
    Choices: Allowed, Preferred, NotPreferred, Prohibited, Required
  • Component(s) to subset (string) : Component(s) to subset.
    Default: [‘solvent’]
    Choices: protein, nucleic, ligand, solvent, metals, counter_ions, lipids, packing_residues, sugars, undefined, cofactors, excipients, polymers, post_translational, other_proteins, other_nucleics, other_ligands, other_cofactors
  • Within Components (string) : Components to calculate distance to for the subsetting.
    Default: [‘protein’, ‘nucleic’, ‘ligand’, ‘cofactors’, ‘other_ligands’, ‘other_cofactors’]
    Choices: protein, nucleic, ligand, solvent, metals, counter_ions, lipids, packing_residues, sugars, undefined, cofactors, excipients, polymers, post_translational, other_proteins, other_nucleics, other_ligands, other_cofactors

Field parameters

  • None (Field Type: StringVec) : Message extended log field
    Default: Extended Log Field
  • None (Field Type: String) : Message log field
    Default: Log Field

Hardware Parameters

Machine hardware requirements

  • Memory (MiB) (decimal) : The minimum amount of memory in MiBs (1048576 B) this cube requires. Due to overhead, request a couple hundred MiB more than required.
    Default: 1800 Min: 256.0 Max: 8589934592
  • Temporary Disk Space (MiB) (decimal) : The minimum amount of disk space in MiB (1048576 B) this cube requires. Due to overhead, request a couple hundred MiB more than required.
    Default: 5120.0 Min: 128.0 Max: 8589934592
  • GPUs (integer) : The number of GPUs to run this cube with
    Default: 0 Max: 16
  • CPUs (integer) : The number of CPUs to run this cube with
    Default: 1 Min: 1 Max: 128
  • Instance Type (string) : The type of instance that this cube needs to be run on
  • Spot policy (string) : Control cube placement on spot market instances
    Default: Prohibited
    Choices: Allowed, Preferred, NotPreferred, Prohibited, Required
  • Instance Tags (string) : Only run on machines with matching tags (comma separated)
    Default: “”

Metrics Parameters

Cube Metric Parameters

  • Metric Period (decimal) : How often to sample metrics, in seconds
    Default: 60 Min: 1 Max: 300
  • Cube Metrics (string) : Set of metrics to be collected

    Choices: cpu, disk, memory, network

Parallel Spruce subset within cube

The parallel version adds these extra parameters.

  • Number of messages to distribute at a time (integer) : The maximum number of messages to bundle together for a parallel cube.
    Default: 1 Min: 1 Max: 65535
  • Maximum Failures (integer) : The maximum number of times to attempt processing a work item
    Default: 10 Min: 1 Max: 100
  • Autoscale this Cube (boolean) : If True, let Orion manage the parallelism of this Cube
    Default: True
  • Maximum number of Cubes (integer) : The maximum number of concurrently running copies of this Cube
    Default: 1000 Min: 1
  • Minimum number of Cubes (integer) : The minimum number of concurrently running copies of this Cube
    Default: 0

Tip

filename: snowball/spruce/subset_cubes.py