<a href="#main" class="skip-link">Skip to main content</a>

<div>

This page provides documentation on how to use the open source Kigali
Sim. [Return to tool](/).

</div>

<div id="main" role="main">

# 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](/guide/tutorial_01.html). Already a pro? See [reference
materials](#qubectalk-reference).

**Prefer a video?** On external websites, we have a quick [5 minute
introduction](https://youtu.be/gDfe7bG8Ppk) ([YouTube terms of
service](https://www.youtube.com/static?template=terms&noapp=1)) or a [1
hour extended guided tutorial experience](https://vimeo.com/1159005072)
([Vimeo terms of service](https://vimeo.com/legal)).

<div id="tutorials" class="section major">

## 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](#qubectalk-reference).

<div id="introduction" class="section no-border">

### Introduction

<div>

[**Tutorial 1:** Introduction to Kigali Sim](/guide/tutorial_01.html) -
Understanding HFCs and how Kigali Sim can help

</div>

</div>

<div id="ui-based-authoring" class="section no-border">

### UI-based Authoring

<div>

[**Tutorial 2:** Single Application and
Substance](/guide/tutorial_02.html) - Start with the basic building
blocks of a simulation

</div>

<div>

[**Tutorial 3:** Multiple Applications and
Substances](/guide/tutorial_03.html) - Expanding to multiple sectors and
refrigerants

</div>

<div>

[**Tutorial 3a:** Multiple Substances with
AI](/guide/tutorial_03a.html) - Expanding to multiple sectors and
refrigerants using AI

</div>

<div>

[**Tutorial 4:** Growth and Trade](/guide/tutorial_04.html) - Adding
economic growth projections and import flows

</div>

<div>

[**Tutorial 4a:** Growth and Trade with AI](/guide/tutorial_04a.html) -
Adding economic growth projections and import flows using AI

</div>

<div>

[**Tutorial 5:** Simple Policies](/guide/tutorial_05.html) - ABC
Country's first policy intervention using a sales permitting system

</div>

<div>

[**Tutorial 6:** Recycling](/guide/tutorial_06.html) - Exploring
secondary material through recycling programs

</div>

<div>

[**Tutorial 6a:** Recycling with AI](/guide/tutorial_06a.html) -
Exploring secondary material through recycling programs using AI

</div>

</div>

<div id="code-based-authoring" class="section no-border">

### Code-based Authoring

<div>

[**Tutorial 7:** First Code](/guide/tutorial_07.html) - Discovering
QubecTalk and implementing multi-substance recycling policies

</div>

<div>

[**Tutorial 8:** Equipment Units-Based
Modeling](/guide/tutorial_08.html) - Alternative consumption
specification using equipment sales data

</div>

</div>

<div id="modeling-cobenefits" class="section no-border">

### Modeling Co-benefits

<div>

[**Tutorial 9:** Global Warming Potential](/guide/tutorial_09.html) -
Demonstrating GWP impact reduction with a sample substitution policy

</div>

<div>

[**Tutorial 10:** Equipment Energy
Efficiency](/guide/tutorial_10.html) - Exploring energy consumption with
equipment model

</div>

</div>

<div id="artificial-intelligence" class="section no-border">

### Artificial Intelligence

<div>

[**Tutorial 11:** AI Coding Assistants](/guide/tutorial_11.html) - Using
AI assistants to help build or modify simulations through code

</div>

<div>

[**Tutorial 11a:** Agentic AI (JVM)](/guide/tutorial_11a.html) - Using
AI agents to autonomously run and iterate on simulations through the JVM

</div>

</div>

<div id="advanced-modeling" class="section no-border">

### Advanced Modeling

<div>

[**Tutorial 12:** Advanced Sales Assumptions](/guide/tutorial_12.html) -
Controlling sales carryover behavior for bank tracking scenarios

</div>

<div>

[**Tutorial 13:** Assumed Replacement](/guide/tutorial_13.html) -
Modeling equipment replacement patterns in business-as-usual scenarios

</div>

<div>

[**Tutorial 14:** Bank-Based Modeling](/guide/tutorial_14.html) -
Tracking substance banks and equipment populations over time

</div>

<div>

[**Tutorial 15:** Variable Retirement and
Servicing](/guide/tutorial_15.html) - Implementing dynamic retirement
rates and service patterns

</div>

<div>

[**Tutorial 16:** Command Line and Monte
Carlo](/guide/tutorial_16.html) - Advanced uncertainty analysis using
probabilistic programming

</div>

<div>

[**Tutorial 17:** Exports](/guide/tutorial_17.html) - Producing
countries with exports

</div>

</div>

</div>

<div id="qubectalk-reference" class="section major">

## Reference

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

<div>

[**Glossary**](/guide/glossary.html) - Definitions of key terms used
throughout Kigali Sim documentation and QubecTalk

</div>

<div>

[**Stanzas Reference**](/guide/qubectalk_stanzas.html) - Program
structure including default, policy, and simulations blocks

</div>

<div>

[**Commands Reference**](/guide/qubectalk_commands.html) - Executable
statements for substance properties, consumption, and policy
interventions

</div>

<div>

[**Language Features
Reference**](/guide/qubectalk_language_features.html) - Advanced
features including conditional logic, probabilistic sampling, and
mathematical operations

</div>

<div>

[**Engine JavaDoc**](/guide/javadoc/) - API documentation for the Java
simulation engine

</div>

<div>

[**Editor JSDoc**](/guide/jsdoc/) - API documentation for the ECMAScript
editor

</div>

<div>

[**Engine and Language Specification**](/guide/qubectalk.pdf) - Formal
technical specification of the QubecTalk language and simulation engine

</div>

<div>

[**Credits**](/guide/credits.html) - Acknowledgments and contributors to
the Kigali Sim project

</div>

</div>

<div class="section major">

## Get help

Need assistance? Email us at <hello@kigalisim.org> or
<a href="https://vimeo.com/1061085671?share=copy" target="_blank">watch
the Vimeo video about all of the support options</a> offered by our
University of California Berkeley team.

</div>

<div class="section major">

## License and Dedication

Code is released under the [BSD 3-Clause
License](https://opensource.org/license/bsd-3-clause). Everything else
in this guide is released under the [CC-BY
License](https://creativecommons.org/licenses/by/4.0/). This guide is
dedicated to Barbara Berke and her dedication to making computation
available to everyone.

</div>

</div>

[View Markdown version](md/index.md)
