BioSimSpace.Process.Somd

class BioSimSpace.Process.Somd(system, protocol, exe=None, name='somd', platform='CPU', work_dir=None, seed=None, property_map={})

A class for running simulations using SOMD.

__init__(system, protocol, exe=None, name='somd', platform='CPU', work_dir=None, seed=None, property_map={})

Constructor.

Parameters
  • system (System) – The molecular system.

  • protocol (Protocol) – The protocol for the SOMD process.

  • exe (str) – The full path to the SOMD executable.

  • name (str) – The name of the process.

  • platform (str) – The platform for the simulation: “CPU”, “CUDA”, or “OPENCL”.

  • work_dir – The working directory for the process.

  • seed (int) – A random number seed.

  • property_map (dict) – A dictionary that maps system “properties” to their user defined values. This allows the user to refer to properties with their own naming scheme, e.g. { “charge” : “my-charge” }

Methods

__delattr__(name, /)

Implement delattr(self, name).

__dir__()

Default dir() implementation.

__eq__(value, /)

Return self==value.

__format__(format_spec, /)

Default object formatter.

__ge__(value, /)

Return self>=value.

__getattribute__(name, /)

Return getattr(self, name).

__gt__(value, /)

Return self>value.

__hash__()

Return hash(self).

__init__(system, protocol[, exe, name, …])

Constructor.

__init_subclass__

This method is called when a class is subclassed.

__le__(value, /)

Return self<=value.

__lt__(value, /)

Return self<value.

__ne__(value, /)

Return self!=value.

__new__(**kwargs)

Create and return a new object.

__reduce__()

Helper for pickle.

__reduce_ex__(protocol, /)

Helper for pickle.

__repr__()

Return a string showing how to instantiate the object.

__setattr__(name, value, /)

Implement setattr(self, name, value).

__sizeof__()

Size of object in memory, in bytes.

__str__()

Return a human readable string representation of the object.

__subclasshook__

Abstract classes can override this to customize issubclass().

_clear_output()

Reset stdout and stderr.

_generate_args()

Generate the dictionary of command-line arguments.

_generate_config()

Generate SOMD configuration file strings.

_getCollectiveVariable(index[, time_series, …])

Get the value of a collective variable.

_getFreeEnergy([index, stride, kt, block])

Get the current free energy estimate.

_getPlumedConfig()

Return the list of PLUMED configuration strings.

_getPlumedConfigFile()

Return path to the PLUMED config file.

_getTime([time_series, block])

Get the time (in nanoseconds).

_sampleConfigurations(bounds[, number, block])

Sample configurations based on values of the collective variable(s).

_setPlumedConfig(config)

Set the list of PLUMED configuration file strings.

_setup()

Setup the input files and working directory ready for simulation.

_writePlumedConfig(file)

Write the PLUMED configuration to file.

addArgs(args)

Append additional command-line arguments.

addToConfig(config)

Add a string to the configuration list.

clearArgs()

Clear all of the command-line arguments.

command()

Return the command-line string used to run the process.

deleteArg(arg)

Delete an argument from the dictionary.

exe()

Return the executable.

getArgString()

Get the command-line arguments string.

getArgStringList()

Convert the argument dictionary into a list of strings.

getArgs()

Get the dictionary of command-line arguments.

getConfig()

Get the list of configuration file strings.

getCurrentGradient([time_series])

Get the current free energy gradient.

getCurrentSystem()

Get the latest molecular system.

getCurrentTime([time_series])

Get the current time (in nanoseconds).

getGradient([time_series, block])

Get the free energy gradient.

getInput([name, file_link])

Return a link to a zip file containing the input files used by the process.

getName()

Return the process name.

getOutput([name, block, file_link])

Return a link to a zip file of the working directory.

getPackageName()

Return the package name.

getSeed()

Return the random number seed.

getStderr([block])

Return the entire stderr for the process as a list of strings.

getStdout([block])

Return the entire stdout for the process as a list of strings.

getSystem([block])

Get the latest molecular system.

getTime([time_series, block])

Get the time (in nanoseconds).

getTrajectory([block])

Return a trajectory object.

inputFiles()

Return the list of input files.

insertArg(arg, value, index)

Insert a command-line argument at a specific index.

isError()

Return whether the process errored.

isQueued()

Return whether the process is queued.

isRunning()

Return whether the process is running.

kill()

Kill the running process.

resetArgs()

Reset the command-line arguments.

resetConfig()

Reset the configuration parameters.

run([system, protocol, auto_start, restart])

Create and run a new process.

runTime()

Return the running time for the process (in minutes).

setArg(arg, value)

Set a specific command-line argument.

setArgs(args)

Set the dictionary of command-line arguments.

setConfig(config)

Set the list of configuration file strings.

setName(name)

Set the process name.

setSeed(seed)

Set the random number seed.

start()

Start the SOMD process.

stderr([n])

Print the last n lines of the stderr buffer.

stdout([n])

Print the last n lines of the stdout buffer.

wait([max_time])

Wait for the process to finish.

workDir()

Return the working directory.

writeConfig(file)

Write the configuration to file.

Attributes

__dict__

__doc__

__module__

__weakref__

list of weak references to the object (if defined)

_platforms