Conda Setup

Installing and configuring BuEM using Conda package manager.

Prerequisites

Make sure you have completed the Setup & Prerequisites page before continuing.

Quick Installation

Create the BuEM environment directly from the repository:

# Clone the repository
git clone https://github.com/your-org/buem.git
cd buem

# Create conda environment
conda env create -f environment.yml

# Activate environment
conda activate buem_env

# Ready to use! Run with:
python -m src.buem.main

Building from Source (Advanced)

To build and install with conda:

conda install conda-build
conda build .
conda install --use-local buem

Note

Development Usage: When using the conda environment with the source code, always prefix commands with src. (e.g., python -m src.buem.main) to avoid import conflicts.

Manual Environment Setup

For custom environment configuration:

# Create new environment
conda create -n buem_env python=3.13
conda activate buem_env

# Install core dependencies
conda install -c conda-forge numpy pandas scipy matplotlib
conda install -c conda-forge requests flask gunicorn

Warning

Do not use pip install buem from PyPI. The PyPI package is outdated (last updated September 2025) and does not match the current codebase. Always install from the repository using conda env create -f environment.yml or conda develop src.

Optional Dependencies

For development and documentation:

# Documentation tools
conda install -c conda-forge sphinx sphinx_rtd_theme

# Development tools
conda install -c conda-forge pytest pytest-cov black flake8

# Jupyter for interactive analysis
conda install -c conda-forge jupyter notebook

Verifying Installation

# Test import
python -c "import buem; print(buem.__version__)"

# Check API server
python -m buem.apis.api_server

# Run tests
pytest tests/

Troubleshooting

Environment conflicts:

# Remove and recreate environment
conda env remove -n buem_env
conda env create -f environment.yml

Module not found errors:

# Re-register the source tree with conda
conda develop src

For additional help, check the container logs or API /api/health endpoint.