Connect from a terminal
Run Plexora on a remote machine with one command, and see it in your own browser through an SSH tunnel.
plexora connect starts Plexora on another machine, opens an SSH tunnel to it and opens your browser. Everything runs over there, next to the data; your screen is the only thing on your computer. Use it when you want the server's processors, or when your projects live on that server.
To open a server's files from Plexora on your own computer you need no terminal at all: use Add a server. This page is the optional command-line route, for running the whole of Plexora on the server.
How to use it
Install Plexora on both machines
On the server, install it with pip (Install with pip). Or let the first connection do it with --install, which runs pip install --upgrade plexora there.
Connect
Run this on your own computer:
plexora connect [email protected]Add a project name to open it straight away: plexora connect [email protected] tonsil. Keep the command running while you work; Ctrl+C disconnects.
Tell it how to find Plexora
If the server's plexora is in a conda environment that a non-interactive SSH login does not activate, name it:
plexora connect me@host --remote-command "/home/me/miniconda3/envs/plexora"Save it
--save lab stores the whole command, so next time it is plexora connect lab. Saved servers are shared with Settings › Remote servers. No password is stored.
Useful options
| Option | Does |
|---|---|
--srun "ARGS" | Run inside a SLURM job. See SLURM clusters. |
-J host | Reach the target through a jump host. |
--ssh-opt KEY=VALUE | Pass an extra ssh -o option. |
--port, --remote-port | Choose the local and remote ends of the tunnel. |
--data-dir PATH | The data directory on the server, for an account that has not chosen one. |
--no-browser | Print the address instead of opening it. |
Keys, ports and usernames are usually better placed in ~/.ssh/config, which Plexora uses as it is.
Tips
plexora connectalso starts a small data node on your own computer, so the remote Plexora can open files from your laptop.--no-local-nodeturns it off.--local-serve table:cells=~/cells.h5adhands one local file to the remote viewer. See Data nodes.