Skip to main content

PyPI - Version PyPI - Python Version PyPI - License PyPI - Downloads PyPI DownloadsGitHub Actions

🚧 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.

FlowReg logo 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

Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

pyflowreg_session_gui-0.1.0.tar.gz (24.8 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

pyflowreg_session_gui-0.1.0-py3-none-any.whl (26.8 kB view details)

Uploaded Python 3

File details

Details for the file pyflowreg_session_gui-0.1.0.tar.gz.

File metadata

  • Download URL: pyflowreg_session_gui-0.1.0.tar.gz
  • Upload date:
  • Size: 24.8 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/6.1.0 CPython/3.13.7

File hashes

Hashes for pyflowreg_session_gui-0.1.0.tar.gz
Algorithm Hash digest
SHA256 ecce4570b01809b42651043912f7008fe1030716a54c3132ea70f9eb16be193b
MD5 543b62f95b766858e4c572a7433065e7
BLAKE2b-256 ac80eebf0846b028d76b95a68ea29cad66c9190bbbe2a89cd2e0a775dfcbafd9

See more details on using hashes here.

Provenance

The following attestation bundles were made for pyflowreg_session_gui-0.1.0.tar.gz:

Publisher: pypi-release.yml on FlowRegSuite/pyflowreg-session-gui

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

File details

Details for the file pyflowreg_session_gui-0.1.0-py3-none-any.whl.

File metadata

File hashes

Hashes for pyflowreg_session_gui-0.1.0-py3-none-any.whl
Algorithm Hash digest
SHA256 8b62eba92e15b2ef85fcbf2f2d41e29b8257fbb09be3292241c34028154df28e
MD5 2d9892b0bc9359423abf473d3ba1eb14
BLAKE2b-256 e0761cefa012d81bf5684994c0f2a38d71bbbd5896482d61e4b6f8c87e4a6a89

See more details on using hashes here.

Provenance

The following attestation bundles were made for pyflowreg_session_gui-0.1.0-py3-none-any.whl:

Publisher: pypi-release.yml on FlowRegSuite/pyflowreg-session-gui

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

Release history Release notifications | RSS feed

This release

0.1.0 This release

2 files

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Sentry Error logging StatusPage Status page