The documentation is organized into the following four sections, roughly adhering to the Diátaxis documentation framework guidelines. For insights into the goals of each of these documentation categories, please refer to the Diátaxis website.
- How-to Guides
- Technical Reference
IMPORANT: If at any point julia-related issues with workflows, environments, and/or package versioning become frustrating, please do not hesitate to reach out. This can be a hurdle to learn at first, but taking a moment to get it right early will save you a lot of time down the road. We are more than happy to help you, and are getting together some standardized resources in the meantime.
We aim to assist users of all different experience levels, starting with first-time users. If this is your first time using Mimi, we recommend you begin with the Tutorials. In addition, looking through the code at the links below to various existing models based on Mimi can be instructive.
The first step for any user includes installation of julia and Mimi, as well as optionally adding the Mimi Registry. See Tutorial 1: Install Mimi for instructions on these tasks.
As we work to enhance and improve Mimi we will release new versions of the package. To make sure you always have the latest version of Mimi installed, we recommend that on occasion you run the
update command at the julia Pkg REPL. This will update all installed packages to their latest version (not just the Mimi package). To only update the Mimi package you may run the following, although we recommend you do a comprehensive update each time as indicated above. See Tutorial 1: Install Mimi for more!
pkg> update Mimi
Finally, when in doubt, ask your question on the Mimi Framework forum or post an Issue to the Github repository, the latter being especially pertintent if you have a specific request for the development team. Don't be shy about either option, we would much prefer to be inundated with lots of questions and help people out than people give up on Mimi!
an asterisk after a model name indicates that this model is registered in the MimiRegistry as described in Tutorial 1
- MimiDICE2016.jl (version R not R2)
- Mimi-CIAM.jl (currently in closed BETA)
- Mimi-BRICK.jl (currently in closed BETA)