plexora node connect
Start a data node on another machine and register it here.
Run plexora node serve on a remote host over SSH, forward it to this machine, and register it -- so a project opened in the Plexora running HERE can read an image that never leaves the cluster. Run this on your own computer.
Usage
plexora node connect [-h] [--serve KIND:ID=PATH] [--name NAME]
[--remote-command REMOTE_COMMAND] [-J JUMP] [--ssh-opt KEY=VALUE]
[--port PORT] [--remote-port REMOTE_PORT] [--timeout TIMEOUT]
[--install] [--plugins PLUGINS] [--pair [ORIGIN]]
targetArguments
targetrequired[user@]host to ssh into.
Options
--serve KIND:ID=PATHrepeatableA resource on the REMOTE host to serve, e.g. --serve image:tonsil=/scratch/tonsil.ome.tif. Repeat for each.
--name NAMEWhat to call this node here. Defaults to the host's name.
--remote-command REMOTE_COMMANDHow to invoke Plexora on the remote host. An environment prefix is enough, e.g. "/home/you/miniconda3/envs/plexora".
-J, --jump JUMPssh -J jump host to reach the target through.
--ssh-opt KEY=VALUErepeatableExtra ssh -o option.
--port PORTLocal port for the tunnel (default: free).
--remote-port REMOTE_PORTPort to use on the remote host.
--timeout TIMEOUTSeconds to wait for the node to answer. Raise it when a segmentation mask has to be converted first.
--installInstall or update Plexora on that host first: pip install --upgrade plexora, in the environment --remote-command names.
--plugins PLUGINSPlugins the node should be able to run.
--pair [ORIGIN]Also print a link that pairs the node with the Plexora page at ORIGIN (default https://viewer.plexoraapp.com), and allow that origin on it. Put it after the host.
Examples
Serve a cluster file to the viewer on your laptop
plexora node connect [email protected] --serve image:tonsil=/scratch/me/tonsil.ome.tifThrough a jump host, installing Plexora there first
plexora node connect me@compute01 -J [email protected] --install --serve table:cells=/scratch/me/cells.h5ad