Navigation: Documentation / Commands / svs-client


vs-client: version 2.231.418d045(2020-03-01 18:49) [CATs - Conversion And Analysis Tools]

Name

vs-client

Synopsis

vs-client [OPTIONS] [--] svs://server[:port]/command

Description

Client of the server/client virtual screening infrastructure.

Arguments

svs://server[:port]/command
Specifies fully qualified administration request. Trasport protocol svs:// has to be always specified, which is followed by the server specification (DNS name or IP address of the server and optionally by the server port). This is followed by the command, which can be one of the following:
register = register client on server side
unregister = unregister client on server side (unregister?id=client_id)
get = get unprocessed structure from database (get?id=client_id,structure=file.ext[,type=xyz])
write = write data to database and set structure as processed (write?id=client_id,molid=molecule_id[,structure=file.ext,type=log])
load = load structure from database (load?id=client_id,molid=molecule_id[,structure=file.ext,type=xyz])
save = save structure to database (save?id=client_id,molid=molecule_id[,structure=file.ext,type=log])
installpkg = install client package to current directory
appname = get client application name
info = prints information about registered clients
shutdown = stops server execution
errors = prints errors from the server stack

Options

-s, --serverkey FILE
name of file containing server description (name, port, and password) (mutually exclusive with 'password' option)
-p, --password FILE
name of file containing server magic word, if not specified then password is read interactively
-v, --verbose
increase output verbosity
--version
output version information and exit
-h, --help
display this help and exit