Installation Guide

This section walks you through every step needed to get BuEM running — from installing prerequisites to configuring Docker or a local conda environment.

Start with the Setup & Prerequisites page, then follow the guide that matches your role.

• Setup & Prerequisites
  • Software Requirements
  • For Users
  • For Developers
  • City2TABULA
  • System Requirements
  • Next Steps
• Docker Installation
  • Quick Start with Docker Compose
  • Docker Compose Configuration
  • Manual Docker Build
  • Development Container
  • Custom Configuration
  • Production Deployment
• Conda Setup
  • Prerequisites
  • Quick Installation
  • Building from Source (Advanced)
  • Manual Environment Setup
  • Optional Dependencies
  • Verifying Installation
  • Troubleshooting
• Development Setup
  • Development Prerequisites
  • Development Installation
  • Code Quality Tools
  • Testing Framework
  • Building Documentation
  • Contribution Workflow
  • Debugging Configuration

Quick Start

For API Integration (Recommended)

docker pull buem:latest
docker run -d -p 5000:5000 buem:latest

For Development

git clone <buem-repository>
cd buem
conda env create -f environment.yml
conda activate buem_env

Installation Options

Method	Use Case	Pros/Cons
Docker Container	Production deployment, API integration	✓ Easy deployment, ✓ Isolated environment, ⚠ Container overhead
Conda Environment	Development, local analysis	✓ Full control, ✓ Easy debugging, ⚠ Dependency management
Cloud Deployment	Scalable production	✓ Auto-scaling, ✓ High availability, ⚠ Cloud complexity

Next Steps

Choose your installation method:

• Docker Installation — production deployment

• Conda Setup — development work

• Production Deployment — scalable deployment