Install MaveScape

MaveScape is one executable. The browser application and the example experiments are inside it, so nothing else needs to be installed. One command downloads the release for your computer, checks it and installs it.

$ curl --proto '=https' --tlsv1.2 -fsSL https://raw.githubusercontent.com/robert-mcdermott/mavescape/main/install.sh | sh

Installs the latest release as ~/.local/bin/mavescape. No sudo, and your PATH is left as it is; if ~/.local/bin is not on it, the installer prints the full path to run.

PS> irm https://raw.githubusercontent.com/robert-mcdermott/mavescape/main/install.ps1 | iex

Run in PowerShell. Installs to %LocalAppData%\Programs\MaveScape and adds it to your user PATH. No administrator rights and no change to the execution policy needed.

Start it

$ mavescape

MaveScape starts a local server on http://127.0.0.1:8820 (or the next free port) and opens its window. If Chrome, Edge, Brave or Chromium is installed, the window is a desktop app window with its own profile; otherwise your default browser is used. Closing the window stops the program. On Windows, open a new terminal after installing so that it sees the updated PATH.

Files and folders named on the command line open directly, and running mavescape <files> again while it is open hands them to the open window:

$ mavescape counts.csv target.fasta

Then continue with Getting started.

Requirements

Operating system	Architecture	Release file
macOS	Apple silicon (ARM64)	`mavescape-darwin-arm64`
macOS	Intel (x64)	`mavescape-darwin-amd64`
Linux	x64	`mavescape-linux-amd64`
Linux	ARM64	`mavescape-linux-arm64`
Windows	x64	`mavescape-windows-amd64.exe`
Windows	ARM64	`mavescape-windows-arm64.exe`

The window is a page in a current browser; MaveScape is tested in Chrome and the browsers built on Chromium. Each release has SHA256SUMS, the checksum of every file; the installers require exactly one matching checksum and run the downloaded program's --version before moving it into place, so a failed download never replaces a working copy.

Options

To install a particular release, or somewhere else:

$ curl --proto '=https' --tlsv1.2 -fsSL https://raw.githubusercontent.com/robert-mcdermott/mavescape/main/install.sh | MAVESCAPE_VERSION=v0.8.0 MAVESCAPE_INSTALL_DIR="$HOME/bin" sh

In PowerShell, set $env:MAVESCAPE_VERSION and $env:MAVESCAPE_INSTALL_DIR before the same command. To read an installer before running it, download it first; INSTALLING.md describes every option, and how to install by hand.

Command-line options

Option	Meaning
`mavescape [files or folders]`	Start and open the files: count and score tables, sequences, designs, workspace archives
`--port N`	Preferred port (default 8820; the next 19 are tried)
`--window app\|browser\|none`	A desktop window, the default browser, or none
`--data-dir DIR`	Where the workspace library is kept
`--no-library`	Keep workspaces in the browser's storage instead
`--keep-running`	Keep serving after the window is closed
`--mavedb URN`	Open a MaveDB score set, as `mavescape urn:mavedb:…` does (Public data)
`--offline`	Make no network request: public data only from copies already in the cache (Public data)
`--no-fetch`	Switch public data off
`--cache-dir DIR`	Where the cache of public data is kept
`--remote-control`	Let programs on this computer drive the window (Remote control)
`--proteoscope off`	Do not look for Proteoscope on this computer; or a port or range (`9000-9010`) to look on instead of its own (Open in Proteoscope)
`--version`	Print the version
`mavescape run …`	Score a table with its design without a window (Headless runs; `mavescape run -h`)
`mavescape validate …`	Check tables and a design as scoring would (Checking before scoring)

Uninstall

Delete the program (~/.local/bin/mavescape, or %LocalAppData%\Programs\MaveScape on Windows). Your workspaces are in the library folder the status bar names, ~/Library/Application Support/MaveScape on macOS; keep or delete it as you like.