🚧 Under Development

This project is still in an alpha stage. Expect rapid changes, incomplete features, and possible breaking updates between releases.

• The API may evolve as we stabilize core functionality.
• Documentation and examples are incomplete.
• Feedback and bug reports are especially valuable at this stage.

pyflowreg-session-gui

Qt (PySide6) desktop application to configure and run PyFlowReg session mode locally or on a remote Slurm cluster through SSH.

Installation (Mamba)

Prerequisites

• mamba (Miniforge/conda-forge recommended)
• Python 3.10+ (examples below use 3.11)
• System ssh and rsync available in PATH
• For remote Slurm submission: working SSH alias (default deigo)
• If you use conda instead of mamba, the commands are the same (mamba -> conda)

1) Create and activate environment

mamba create -n flowreg_gui python=3.11 -y
mamba activate flowreg_gui

2) Install from PyPI (recommended)

python -m pip install pyflowreg-session-gui

3) Verify installation

python -c "import pyflowreg_session_gui; print(pyflowreg_session_gui.__version__)"

Alternative: Editable install from source

git clone https://github.com/FlowRegSuite/pyflowreg-session-gui.git
cd pyflowreg-session-gui
python -m pip install -e .

For development tools (ruff, pytest):

python -m pip install -e .[dev]

Start The GUI

Preferred entrypoint:

pyflowreg-session-gui

Alternative:

python -m pyflowreg_session_gui.app

Remote Slurm Setup (GUI Tab: "Run Remote (slurm)")

Before using remote actions in the GUI, run this once in a terminal to ensure host key/auth are configured:

ssh -o StrictHostKeyChecking=accept-new deigo "echo connected"

If host key changed:

ssh-keygen -R deigo
ssh -o StrictHostKeyChecking=accept-new deigo "echo connected"

Then in the GUI:

• Set SSH host alias (default deigo)
• Set Remote base dir
• Use Test SSH before Upload Config / Submit