Getting StartedDesktop Installation

Desktop Installation

The BioNodulo desktop application is free and open-source (GPL-3). It bundles the node editor and a local execution engine, so you can build and run workflows entirely on your own machine — no account required.

System requirements

ResourceMinimumRecommended
OSmacOS 12+, Windows 10+, Ubuntu 20.04+Latest stable release
RAM8 GB32 GB+ (genomics is memory-bound)
Disk10 GB free100 GB+ for reference data & outputs
CPU4 cores8+ cores

Some nodes (alignment, assembly) require substantially more RAM than the minimum. If your local machine is too small, run those steps on the cloud platform instead.

Install

Packaged desktop installers are WIP. The release pipeline targets GitHub Releases, but there is not yet a public .dmg, .exe, AppImage, .deb, Homebrew cask, or winget package to install.

The planned macOS distribution is a signed .dmg published on the GitHub Releases page. Until the first release is published, run from source below.

Run from source

The desktop app and core engine are open source. You’ll need Python 3.11+ and Node.js 20+ (micromamba is auto-installed on first startup for tool environments). To run from source:

git clone https://github.com/Classacre/BioNodulo.git
cd BioNodulo
 
# Install Python dependencies
pip install -e .
 
# Build the frontend
cd web && npm install && npm run build && cd ..
 
# Start the application (then open http://localhost:8000)
python main.py

For development with auto-reload, make dev starts the backend on port 8765 (python main.py --dev) and the Vite dev server on port 5173.

Verify the install

Launch the app. You should see an empty canvas with a node palette on the left. Open Help → About and confirm the version matches the release you installed.

Next steps