Tutorials Intro

Introduction

The following tutorials target Mimi users of different experience levels, starting with first-time users. Before engaging with these tutorials, we recommend that users read the Welcome to Mimi documentation, including the User Guide, and refer back to those documents as needed to follow the tutorials. It will also be helpful to be comfortable with the basics of the Julia language, though expertise is not required.

If you find a bug in these tutorials, or have a clarifying question or suggestion, please reach out via Github Issues or our Mimi Framework forum. We welcome your feedback.

Terminology

The following terminology is used throughout the documentation.

Application Programming Interface (API): The public classes, methods, and functions provided by Mimi to facilitate construction of custom scripts and work with existing models. Function documentation provided in "docstrings" in the Reference define the Mimi API in more detail.

Available Tutorials

  1. Run an Existing Model

    Tutorial 1: Run an Existing Model steps through the tasks to download, run, and view the results of a registered model such as FUND. It should be usable for all users, including first-time users, and is a good place to start when learning to use Mimi.

  2. Modify an Existing Model

    While the instructions in this tutorial are informative, the code examples are based on Mimi DICE-2010 which is not currently publically available, so the use is currently limited. This issue will be resolved soon.

    Tutorial 2: Modify an Existing Model builds on Tutorial 1, showing how to modify an existing model such as DICE.

  3. Create a Model

    Tutorial 3: Create a Model takes a step beyond using registered models, explaining how to create a model from scratch.

  4. Sensitivity Analysis

    Tutorial 4: Sensitivity Analysis (SA) Support explores Mimi's Sensitivity Analysis support, using both the simple 2-Region tutorial model and FUND examples.

Requirements and Initial Setup

These tutorials require Julia v1.0.0 and Mimi v0.6.0, or later.

To use the following tutorials, follow the steps below.

  1. Download the latest version of Julia here, making sure that your downloaded version is v1.0.0 or later.

  2. Open a Julia REPL, and enter ] to enter the Pkg REPL mode, and then type add Mimi to install the latest tagged version of Mimi, which must be version 0.6.0 or later.

pkg> add Mimi
  1. To access the models in the MimiRegistry, you first need to connect your julia installation with the central Mimi registry of Mimi models. This central registry is like a catalogue of models that use Mimi that is maintained by the Mimi project. To add this registry, run the following command at the julia package REPL:
pkg> registry add https://github.com/mimiframework/MimiRegistry.git

You only need to run this command once on a computer.

From there you will be add any of the registered packages, such as MimiRICE2010.jl by running the following command at the julia package REPL:

pkg> add MimiRICE2010
  1. We also recommend that you frequently update your packages and requirements using the update command, which can be abbreviated up:
pkg> up

You are now ready to begin the tutorials!