This page provides documentation on how to use the open source Kigali Sim. Return to tool.

Kigali Sim Guide

Hello! This website provides a series of tutorials and other resources intended to help you both get started and master Kigali Sim. If you are new, consider beginning your journey with the first tutorial. Already a pro? See reference materials.

Tutorials

We think of the user's guide as a book and each tutorial like a chapter. We recommend that readers start here before using reference materials.

Introduction

Tutorial 1: Introduction to Kigali Sim - Understanding HFCs and how Kigali Sim can help

UI-based Authoring

Tutorial 2: Single Application and Substance - Start with the basic building blocks of a simulation
Tutorial 3: Multiple Applications and Substances - Expanding to multiple sectors and refrigerants
Tutorial 4: Growth and Trade - Adding economic growth projections and import flows
Tutorial 5: Simple Policies - ABC Country's first policy intervention using a sales permitting system
Tutorial 6: Recycling - Exploring secondary material through recycling programs

Code-based Authoring

Tutorial 7: First Code - Discovering QubecTalk and implementing multi-substance recycling policies
Tutorial 8: Equipment Units-Based Modeling - Alternative consumption specification using equipment sales data

Modeling Co-benefits

Tutorial 9: Global Warming Potential - Demonstrating GWP impact reduction with a sample substitution policy
Tutorial 10: Equipment Energy Efficiency - Exploring energy consumption with equipment model

Artificial Intelligence

Tutorial 11: AI Assistants - Using AI assistants to help build or modify simulations

Advanced Modeling

Tutorial 12: Advanced Sales Assumptions - Controlling sales carryover behavior for bank tracking scenarios
Tutorial 13: Assumed Replacement - Modeling equipment replacement patterns in business-as-usual scenarios
Tutorial 14: Bank-Based Modeling - Tracking substance banks and equipment populations over time
Tutorial 15: Variable Retirement and Servicing - Implementing dynamic retirement rates and service patterns
Tutorial 16: Command Line and Monte Carlo - Advanced uncertainty analysis using probabilistic programming
Tutorial 17: Exports - Producing countries with exports

Reference

Complete reference documentation for Kigali Sim and QubecTalk, the domain-specific language used by Kigali Sim for advanced modeling and policy analysis.

Glossary - Definitions of key terms used throughout Kigali Sim documentation and QubecTalk
Stanzas Reference - Program structure including default, policy, and simulations blocks
Commands Reference - Executable statements for substance properties, consumption, and policy interventions
Language Features Reference - Advanced features including conditional logic, probabilistic sampling, and mathematical operations
Engine and Language Specification - Formal technical specification of the QubecTalk language and simulation engine
Credits - Acknowledgments and contributors to the Kigali Sim project

Get help

Need assistance? Email us at hello@kigalisim.org or learn about all of the support options offered by our University of California Berkeley team.

License and Dedication

Code is released under the BSD 3-Clause License. Everything else in this guide is released under the CC-BY License. This guide is dedicated to Barbara Berke and her dedication to making computation available to everyone.