Skip to content
phynite-lab
Phynite DocumentationDownload

Install, update, and diagnose the npm app

The published npm app is the local-first path for running the workspace, native DFT, MD, and analysis on your computer. It does not require a Phynite login, Docker, a source checkout, or global Python.

Complete guide

Install and start

Open full resolution

Real local demo workspace. Start with New project; Cloud login is optional.

Real local demo workspace. Start with New project; Cloud login is optional.

The current published package is phynite-lab@0.1.5. Node.js version >=22.13.0 is required. npm installs the launcher and the matching optional native application package for the host OS and CPU.

Keep npm optional dependencies enabled. If a package manager was configured with --omit=optional or the selected platform package was removed, the launcher reports a missing runtime instead of silently using a development fixture.

The launcher binds services to loopback, opens a browser, and stores the local workspace under ~/.phynite-lab. User projects and runtimes remain outside the npm installation directory.

Example / commands
npm install -g phynite-lab@latest
phynite-lab

Supported platforms

PlatformPackage/runtimeNotes
macOS Apple Silicondarwin-arm64Native arm64 package.
Linux ARM64linux-arm64Requires glibc >=2.39 and verified user namespaces.
Linux x64 / Omarchy / Archlinux-x64Requires glibc >=2.39 and verified user namespaces.
WindowsWSL2 linux-x64Run npm and phynite-lab inside WSL2; a Windows-native solver is not installed.

Launcher commands and workspace identity

The default command starts the service in the foreground. --no-open prints the loopback URL without opening a browser. --port requests a port; if it is already used, the launcher selects an available loopback port and reports the actual origin. --data-dir gives each workspace its own database, projects, runtimes, and logs.

status reports the healthy instance for that data directory. stop asks the instance owned by that workspace to shut down cleanly. doctor checks distribution identity, service readiness, data paths, and startup diagnostics. Launching the same workspace again reuses its healthy instance instead of starting a duplicate.

Example / commands
phynite-lab --no-open --port 3000 --data-dir /path/to/workspace
phynite-lab status --data-dir /path/to/workspace
phynite-lab doctor --data-dir /path/to/workspace
phynite-lab stop --data-dir /path/to/workspace

Update without losing projects

The local app may show an update notice after checking https://registry.npmjs.org/phynite-lab/latest. A successful check is cached for up to six hours; an unavailable or invalid response is retried after about five minutes. The check sends no project data or credentials, does not install anything automatically, and never blocks local work while offline.

  1. Finish or cancel active jobs and stop the current instance.
  2. Run the npm update command from the same Node installation that owns the global package.
  3. Start the app again and open Settings → Compute to confirm the runtime capabilities remain available.
  4. If startup fails, run phynite-lab doctor and inspect the logs in the selected data directory; reinstalling the package does not remove ~/.phynite-lab.
Example / commands
npm install -g phynite-lab@latest
phynite-lab --version

Common npm startup fixes

SymptomCheck
Node version rejectedRun node --version and install a Node.js version satisfying >=22.13.0.
Missing runtime packageReinstall with optional dependencies enabled; check the package target reported by doctor.
Port already usedUse --no-open, follow the printed port, or choose --port with a free value.
Projects are missingUse the original --data-dir; each directory is an independent workspace.
Startup service stoppedRun status and doctor, then read logs/<service>.log in the data directory.
Update is unavailableContinue offline, check npm/network later, and retry; the notice is informational.

Related topics

Your privacy

Cookie preferences

Choose whether Phynite may use optional analytics in this browser. You can change this anytime.

Waiting for your choice

This choice applies to this browser, including your workspace.

Read the privacy notice