Installation¶

Learn how to install the epycloud CLI tool for managing serverless epidemic modeling pipelines on Google Cloud.

Prerequisites¶

Operating System: Linux or macOS (Windows via WSL)
Python: 3.11 or higher (managed by uv)
Git: For cloning the repository
Google Cloud Account: For cloud deployments (optional for local development)

Install with uv¶

This method installs epycloud as a globally available command without affecting your system Python.

Step 1: Install uv Package Manager¶

uv is a fast Python package and project manager, written in Rust. We use it to install epycloud as an isolated CLI tool.

uvuv is an extremely fast Python package and project manager, written in Rust.

docs.astral.sh

Install:

$ curl -LsSf https://astral.sh/uv/install.sh | sh

After installation, restart your shell or run:

$ source ~/.bashrc  # or ~/.zshrc for zsh users

Step 2: Install epycloud¶

$ git clone https://github.com/mobs-lab/epymodelingsuite-cloud
$ cd epymodelingsuite-cloud

$ uv tool install .

$ epycloud --version

The tool will be installed in ~/.local/bin/epycloud.

Step 3: Update epycloud¶

When pulling new code changes:

$ cd epymodelingsuite-cloud
$ git pull
$ uv tool upgrade epycloud

Alternative: Development Mode¶

For contributing to epycloud or developing features:

$ git clone https://github.com/mobs-lab/epymodelingsuite-cloud
$ cd epymodelingsuite-cloud

$ uv sync

$ uv run epycloud --help
$ uv run epycloud config show

When to Use Development Mode

Contributing to the epycloud project
Testing local code changes before committing
Debugging CLI functionality

For regular usage, stick with the regular installation.

Verify Installation¶

After installation, verify epycloud is available:

$ epycloud --version

$ epycloud --help

$ epycloud config --help

Expected output:

epycloud 0.3.12

Next Steps¶

Quick Start: Initialize configuration and run your first workflow
Configuration Guide: Learn about the configuration system

Troubleshooting¶

Command not found: epycloud¶

If epycloud is not found after installation:

Check that ~/.local/bin is in your PATH:

$ echo $PATH | grep -q "$HOME/.local/bin" && echo "Found" || echo "Not found"

Add to PATH if missing (add to ~/.bashrc or ~/.zshrc):
```
$ export PATH="$HOME/.local/bin:$PATH"
```
Restart your shell or source the config:
```
$ source ~/.bashrc  # or ~/.zshrc
```