<!-- Documentation index: https://mobs-lab.github.io/epymodelingsuite-cloud/llms.txt -->
<!-- Full documentation: https://mobs-lab.github.io/epymodelingsuite-cloud/llms-full.txt -->

# Introduction

**[epymodelingsuite-cloud](https://github.com/mobs-lab/epymodelingsuite-cloud)** provides infrastructure to run epidemic modeling workflows at scale on **Google Cloud**, with a dedicated CLI tool (**epycloud**) that provides a developer-friendly interface. It runs **[epymodelingsuite](https://github.com/mobs-lab/epymodelingsuite)**, a Python package designed for simulating and calibrating epidemic models using YAML-defined experiment sets on the [epydemix](https://github.com/epistorm/epydemix) engine, which allows for routine forecasts.

## Just One Command

Once set up, running epidemic forecasts is this simple:

```bash
epycloud run workflow --exp-id myexperiment
```

## Built on epydemix

This project is built on [epydemix](https://github.com/epistorm/epydemix), a Python package for epidemic modeling. See [Ecosystem](https://mobs-lab.github.io/epymodelingsuite-cloud/overview/ecosystem.md) for how the components fit together.

## Local and cloud support

The pipeline is designed to run both **locally** and on the **cloud**. All stages run inside Docker containers, so switching between local and cloud is transparent; just add `--local` option to run on your machine.

For more details, see [Architecture: Execution Modes](https://mobs-lab.github.io/epymodelingsuite-cloud/architecture/execution-modes.md).

## Learn More

To understand the system in depth:

<div class="grid cards" markdown>

-   :material-package-variant:{ .lg .middle } **[Ecosystem](https://mobs-lab.github.io/epymodelingsuite-cloud/overview/ecosystem.md)**

    ---

    Learn about the repositories that make up the system

-   :material-console:{ .lg .middle } **[epycloud CLI](https://mobs-lab.github.io/epymodelingsuite-cloud/overview/epycloud.md)**

    ---

    Learn about the command-line tool and key commands

</div>

## Next Steps

Ready to start using epycloud?

- **[Installing epycloud](https://mobs-lab.github.io/epymodelingsuite-cloud/getting-started/installation.md)**: Install the epycloud CLI tool
- **[Quick Start](https://mobs-lab.github.io/epymodelingsuite-cloud/getting-started/local.md)**: Run your first local workflow in 10 minutes
- **[Cloud Deployment](https://mobs-lab.github.io/epymodelingsuite-cloud/getting-started/cloud-deployment/index.md)**: Deploy infrastructure to Google Cloud

For technical deep dive:

- **[Architecture Overview](https://mobs-lab.github.io/epymodelingsuite-cloud/architecture/index.md)**: Detailed system architecture