OverviewDesktop App

Desktop App

Biosimulant Desktop is a graphical workbench for browsing labs, editing models, running simulations, and inspecting results. It consumes the same headless biosimulant Python package available through PyPI.

Desktop-specific behavior—windows, navigation, notifications, visual settings, cancellation presentation, and local application state—remains private application code rather than public CLI commands.

Before you start

  • Time: about 10 minutes for Desktop installation and managed CLI verification.
  • Requirements: a supported Desktop platform, or Python 3.10+ for CLI-only use.
  • Outcome: Desktop launches and its managed biosimulant version passes doctor.

Install Desktop

Download the app from the Biosimulant Desktop page.

PlatformRequirement
macOS11 (Big Sur)+, Apple Silicon or Intel
Windows10 version 1803+, 64-bit
LinuxUbuntu 20.04+, Fedora 36+, or equivalent

Desktop provisions a managed Python environment containing the exact checksum-verified CLI wheel associated with that Desktop release. Open Settings > CLI Tools to inspect:

  • managed CLI and expected versions
  • Python environment path
  • wheel and dependency-lock checksums
  • shell launcher and PATH status
  • lab runtime readiness

Verify the installation

After adding the launcher to PATH, open a new terminal:

biosimulant --version
biosimulant doctor
biosimulant runtime status --json

Installing Desktop is not required for headless use. Local terminals, CI runners, and servers can install the same CLI with pipx install biosimulant.

Open your first lab

  1. Launch Desktop and open Projects.
  2. Create a lab, import a package, or open a lab.yaml.
  3. Inspect its models, wiring, run history, and local files.
  4. Use Desktop’s run controls or execute the same project with biosimulant labs run.

Troubleshooting

  • Command not found: open Settings > CLI Tools, install or repair the shell launcher, apply the displayed PATH change, and open a new terminal.
  • Version mismatch: repair the managed CLI from Settings so it matches the Desktop release.
  • Runtime unavailable: run biosimulant runtime prepare, then biosimulant doctor.
  • Headless setup: use Install and upgrade rather than installing the GUI.

Next steps