sparc.client module

sparc.client.main()[source]

Running SPARC-X-API as a socket client from command line

The client wraps a socket communication layer on top of the SPARC binary. The implementation is both compatible with SocketIOCalculator in ase (using standard i-PI protocol), or with SPARC-X-API in socket server mode (using SPARC’s extended i-PI protocol).

Usage: 1. Start the socket client and outputs to current directory:

python -m sparc.client -s host:port –workdir .

If the workdir is a SPARC calculation bundle, the initial atoms and parameters will be reloaded.

  1. Start the socket client with initial atoms read from file

    python -m sparc.client -s host:port –atoms-from-file input.xyz

If the client is communicating with the standard i-PI server, an initial atoms object is required (either read from SPARC input files or via –atoms-from-file). However, if the server uses the SPARC protocol, the client can be started without initial atoms.

sparc.client.split_socket_name(name)[source]

Split the host:address

Returns:

(host, port, unixsocket) tuple