Contents Menu Expand Light mode Dark mode Auto light/dark, in light mode Auto light/dark, in dark mode Skip to content
v0.1.0 — IGEM is in early access. See release notes.
IGEM Documentation
Logo
IGEM Documentation

Getting Started

  • Getting Started
    • Installation
    • Quickstart
    • Concepts

User Guide — IGEM

  • User Guide — IGEM
    • Loading data
    • Describing data
    • Modifying data
    • Analyzing data
    • Plotting data
    • Reporting data
    • Report catalogue

User Guide — IGEM Server

  • User Guide — IGEM Server
    • The GE facade
    • Database
      • Alembic
      • Commands
      • Snapshots
      • Access
      • Models
      • Backup
    • ETL pipelines
    • NLP and entity resolution
    • Server-side reports

Operations

  • Operations
    • Server setup (PostgreSQL backend)
    • ETL pipeline
    • Snapshot generation
    • Container deployment (Docker / Apptainer)
    • Monitoring & maintenance

Cookbook

  • Cookbook
    • Phenotype analysis
    • Filtered EWAS on NHANES
    • GxE interaction with a pathway prior
    • Building a custom report end-to-end
    • Container and HPC workflows
    • HPC job array recipe

API Reference

  • API Reference
    • igem (client)
    • igem-server (backend)
    • Glossary

Development

  • Development
    • Contributing
    • Architecture deep-dive
    • Release process
    • Adding a new ETL data source

Release Notes

  • Release Notes
Back to top

Getting Started¶

Install IGEM, run your first analysis, and learn the core concepts of the client/server/snapshot model.

  • Installation
  • Quickstart
  • Concepts
Next
Installation
Previous
Home
Copyright © 2026, Hall Lab
Made with Sphinx and @pradyunsg's Furo