Installation

Prerequisites

  • Python 3.13

  • uv package manager

  • Git

You also need access to a running Atlantis API server — either a deployed instance (production or development) or a local development server.

Install from Source

git clone https://github.com/vivarium-collective/sms-api.git
cd sms-api
uv sync

This installs the atlantis command and all three client applications (CLI, TUI, Web GUI).

Verify the Installation

uv run atlantis help

You should see the Atlantis banner and a list of available commands.

Connecting to an API Server

By default, Atlantis connects to http://localhost:8080. Override this with --base-url on any command, or set the API_BASE_URL environment variable:

# Use a specific server for one command
uv run atlantis simulator latest --base-url https://sms.cam.uchc.edu

# Or set it for your entire session
export API_BASE_URL=https://sms.cam.uchc.edu
Available Servers

Server

URL

Production

https://sms.cam.uchc.edu

Development

https://sms-dev.cam.uchc.edu

Local (default)

http://localhost:8080