- RemoteKernelObject["spec",options …] can be used to override default settings for a kernel specification.
- The following remote kernel specifications are recognized:
"ssh://user@hostname:port/path" a kernel on the given machine, accessed using SSH "ssh://hostname" use the default path, user and port on the given machine "hostname" equivalent to "ssh://hostname" "wstp://server:port/pool" a kernel on a WSTPServer "wstp://server" use the default port and kernel pool "localhost" a kernel on the same machine "https://www.wolframcloud.com/" a kernel in the Wolfram Cloud
- Settings for ssh kernels include:
"Host" None the name of the machine to connect to "Username" None the login name that ssh should use "Method" (OS-dependent) how to connect to the kernel on the remote machine "RemoteKernelCommand" "wolfram" the kernel program to run "RemoteKernelArguments" (OS-dependent) arguments to pass the the kernel program "SSHCommand" "ssh" the name of the ssh command "SSHArguments" (see below) arguments to pass to the ssh command "SSHIdentity" None the private ssh key to use "ForwardPort" Random remote port to use for connection forwarding "Timeout" 5 number of seconds to wait for a connection
- The connection method "Launch" is the default on macOS and Linux. It uses LinkLaunch to invoke ssh and uses stdin/stdout for the WSTP connection to the remote kernel.
- The connection method "Forward" is the default on Windows. It creates a listening WSTP socket on the local machine and forwards the kernel connection inside an ssh tunnel from the remote kernel to the listening socket.
- If the "wolfram" command is not on the search path on the remote machine, the absolute path to the remote kernel command should be given as value of "RemoteKernelCommand".
- If "Username" is not set or is None, no username part is given on the ssh command line. "Username"$Username sets the remote username to be the same as the local one.
- "Username" and "RemoteKernelCommand" can also be given as part of the specification as "ssh://user@hostname:port/path".
- The default "SSHArguments" are -x -o StrictHostKeyChecking=accept-new -o BatchMode=yes.
- Ssh cannot ask for passwords interactively. Keys can be specified, or an ssh password agent can be used.
- Settings for WSTPServer kernels include:
"Host" None the name of the server to connect to "Port" 31415 the port to connect to "Pool" Automatic the kernel pool to request
- If the kernel pool is not specified, the WSTPServer chooses a kernel from the default pool.
- Settings for Cloud kernels include:
"CloudBase" None the cloud base
- The cloud base is given in the form of an https URL.
- Settings for local kernels include:
"LocalKernelCommand" (OS-dependent) the kernel program to launch "LocalKernelArguments" (OS-dependent) arguments to pass to the kernel program
Examplesopen allclose all
Basic Examples (2)
Ssh Kernels (2)
WSTPServer Kernels (2)
Local Kernels (2)
If no options are needed, RemoteKernelObject can be omitted:
Wolfram Research (2020), RemoteKernelObject, Wolfram Language function, https://reference.wolfram.com/language/ref/RemoteKernelObject.html.
Wolfram Language. 2020. "RemoteKernelObject." Wolfram Language & System Documentation Center. Wolfram Research. https://reference.wolfram.com/language/ref/RemoteKernelObject.html.
Wolfram Language. (2020). RemoteKernelObject. Wolfram Language & System Documentation Center. Retrieved from https://reference.wolfram.com/language/ref/RemoteKernelObject.html