You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
By contributing code to Mimi.jl, you are agreeing to release that code under the [MIT License](https://github.com/anthofflab/Mimi.jl/blob/master/LICENSE).
1
+
By contributing code to Mimi.jl, you are agreeing to release that code under the [MIT License](https://github.com/mimiframework/Mimi.jl/blob/master/LICENSE).
A [Julia](http://julialang.org) package for [integrated assessment models](https://en.wikipedia.org/wiki/Integrated_assessment_modelling). For more information, see the **[Documentation](http://anthofflab.berkeley.edu/Mimi.jl/stable/)**.
12
+
A [Julia](http://julialang.org) package for [integrated assessment models](https://en.wikipedia.org/wiki/Integrated_assessment_modelling). For more information, see the **[Documentation](https://www.mimiframework.org/Mimi.jl/stable/)**.
13
13
14
14
Please get in touch with [David Anthoff](http://www.david-anthoff.com) if you are interested in using this framework or want to be involved in any way with this effort.
15
15
@@ -19,7 +19,7 @@ Mimi is a package that provides a component model for integrated assessment mode
19
19
20
20
Also see the [OptiMimi](http://github.com/jrising/OptiMimi.jl) package for optimizing parameters within Mimi models.
21
21
22
-
Porting to [Mimi 0.5.0](https://github.com/anthofflab/Mimi.jl/releases/tag/v0.5.1): If you are adapting models to the [Mimi 0.5.0](https://github.com/anthofflab/Mimi.jl/releases/tag/v0.5.1) breaking release or later, please use the [Integration Guide](http://anthofflab.berkeley.edu/Mimi.jl/stable/integrationguide/) as guide to help port your models as easily as possible.
22
+
Porting to [Mimi 0.5.0](https://github.com/mimiframework/Mimi.jl/releases/tag/v0.5.1): If you are adapting models to the [Mimi 0.5.0](https://github.com/mimiframework/Mimi.jl/releases/tag/v0.5.1) breaking release or later, please use the [Integration Guide](https://www.mimiframework.org/Mimi.jl/stable/integrationguide/) as guide to help port your models as easily as possible.
23
23
24
24
[Julia 1.0](https://julialang.org/blog/2018/08/one-point-zero): Mimi has now been ported to Julia 1.0.
Copy file name to clipboardExpand all lines: docs/src/installation.md
+2-2Lines changed: 2 additions & 2 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -40,6 +40,6 @@ There are various editors around that have julia support:
40
40
41
41
The best way to get started with Mimi is to work through the **Tutorials**.
42
42
43
-
The [Mimi](https://github.com/anthofflab/Mimi.jl) github repository also has links to various models that are based on Mimi, and looking through their code can be instructive.
43
+
The [Mimi](https://github.com/mimiframework/Mimi.jl) github repository also has links to various models that are based on Mimi, and looking through their code can be instructive.
44
44
45
-
Finally, when in doubt, ask your question in the [Mimi Framework forum](https://forum.mimiframework.org) or post an [Issue](https://github.com/anthofflab/Mimi.jl/issues) to the Github repository 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!
45
+
Finally, when in doubt, ask your question in the [Mimi Framework forum](https://forum.mimiframework.org) or post an [Issue](https://github.com/mimiframework/Mimi.jl/issues) to the Github repository 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!
-[Git](https://git-scm.com/downloads) and [Github](https://github.com)
10
10
11
11
If you have not yet prepared these, go back to the main tutorial page and follow the instructions for their download.
@@ -103,7 +103,7 @@ Mimi provides support for plotting using [VegaLite](https://github.com/vega/vega
103
103
104
104
#### Explore
105
105
106
-
If you wish to explore the results graphically, use the explorer UI, described [here](http://anthofflab.berkeley.edu/Mimi.jl/stable/userguide/#Plotting-and-the-Explorer-UI-1) in Section 5 of the Mimi User Guide.
106
+
If you wish to explore the results graphically, use the explorer UI, described [here](https://www.mimiframework.org/Mimi.jl/stable/userguide/#Plotting-and-the-Explorer-UI-1) in Section 5 of the Mimi User Guide.
107
107
108
108
To explore all variables and parameters of FUND in a dynamic UI app window, use the [`explore`](@ref) function called with the model as the required first argument, and the optional argument of the `title` The menu on the left hand side will list each element in a label formatted as `component: variable/parameter`.
-[Git](https://git-scm.com/downloads) and [Github](https://github.com)
12
12
13
13
If you have not yet prepared these, go back to the main tutorial page and follow the instructions for their download.
@@ -18,11 +18,11 @@ Futhermore, this tutorial uses the [DICE](https://github.com/anthofflab/mimi-dic
18
18
19
19
There are various ways to modify an existing model, and this tutorial aims to introduce the Mimi API relevant to this broad category of tasks. It is important to note that regardless of the goals and complexities of your modifications, the API aims to allow for modification **without alteration of the original code for the model being modified**. Instead, you will download and run the new model, and then use API calls to modify it. This means that in practice, you should not need to alter the source code of the model they are modifying. Thus, it is easy to keep up with any external updates or improvements made to that model.
20
20
21
-
Possible modifications range in complexity, from simply altering parameter values, to adjusting an existing component, to adding a brand new component. These take advantage of the public API listed [here](http://anthofflab.berkeley.edu/Mimi.jl/dev/reference/), as well as other functions listed in the Mimi Documentation.
21
+
Possible modifications range in complexity, from simply altering parameter values, to adjusting an existing component, to adding a brand new component. These take advantage of the public API listed [here](https://www.mimiframework.org/Mimi.jl/dev/reference/), as well as other functions listed in the Mimi Documentation.
22
22
23
23
## Parametric Modifications: The API
24
24
25
-
Several types of changes to models revolve around the parameters themselves, and may include updating the values of parameters and changing parameter connections without altering the elements of the components themselves or changing the general component structure of the model. The most useful functions of the common API in these cases are likely **[`update_param!`](@ref)/[`update_params!`](@ref), [`disconnect_param!`](@ref), and [`connect_param!`](@ref)**. For detail on these functions see the API reference [here](http://anthofflab.berkeley.edu/Mimi.jl/dev/reference/).
25
+
Several types of changes to models revolve around the parameters themselves, and may include updating the values of parameters and changing parameter connections without altering the elements of the components themselves or changing the general component structure of the model. The most useful functions of the common API in these cases are likely **[`update_param!`](@ref)/[`update_params!`](@ref), [`disconnect_param!`](@ref), and [`connect_param!`](@ref)**. For detail on these functions see the API reference [here](https://www.mimiframework.org/Mimi.jl/dev/reference/).
26
26
27
27
When the original model calls [`set_param!`](@ref), Mimi creates an external parameter by the name provided, and stores the provided scalar or array value. The functions [`update_param!`](@ref) and [`update_params!`](@ref) allow you to change the value associated with this external parameter. Note that if the external parameter has a `:time` dimension, use the optional argument `update_timesteps=true` to indicate that the time keys (i.e., year labels) associated with the parameter should be updated in addition to updating the parameter values.
28
28
@@ -124,7 +124,7 @@ Note that here we use the `update_timesteps` flag and set it to `true`, because
124
124
125
125
## Component and Structural Modifications: The API
126
126
127
-
Most model modifications will include not only parametric updates, but also strutural changes and component modification, addition, replacement, and deletion along with the required re-wiring of parameters etc. The most useful functions of the common API, in these cases are likely **[`replace_comp!`](@ref), [`add_comp!`](@ref)** along with **`Mimi.delete!`** and the requisite functions for parameter setting and connecting. For detail on the public API functions look at the API reference [here](http://anthofflab.berkeley.edu/Mimi.jl/dev/reference/).
127
+
Most model modifications will include not only parametric updates, but also strutural changes and component modification, addition, replacement, and deletion along with the required re-wiring of parameters etc. The most useful functions of the common API, in these cases are likely **[`replace_comp!`](@ref), [`add_comp!`](@ref)** along with **`Mimi.delete!`** and the requisite functions for parameter setting and connecting. For detail on the public API functions look at the API reference [here](https://www.mimiframework.org/Mimi.jl/dev/reference/).
128
128
129
129
If you wish to modify the component structure we recommend you also look into the **built-in helper components `adder`, `ConnectorCompVector`, and `ConnectorCompMatrix`** in the `src/components` folder, as these can prove quite useful.
Copy file name to clipboardExpand all lines: docs/src/tutorials/tutorial_3.md
+2-2Lines changed: 2 additions & 2 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -2,12 +2,12 @@
2
2
3
3
This tutorial walks through the steps to create a new model, first a one-region model and then a more complex two-region model.
4
4
5
-
While we will walk through the code step by step below, the full code for implementation is also available in the `examples/tutorial` folder in the [Mimi](https://github.com/anthofflab/Mimi.jl) github repository.
5
+
While we will walk through the code step by step below, the full code for implementation is also available in the `examples/tutorial` folder in the [Mimi](https://github.com/mimiframework/Mimi.jl) github repository.
6
6
7
7
Working through the following tutorial will require:
8
8
9
9
-[Julia v1.0.0](https://julialang.org/downloads/) or higher
-[Git](https://git-scm.com/downloads) and [Github](https://github.com)
10
10
11
11
If you have not yet prepared these, go back to the main tutorial page and follow the instructions for their download.
@@ -14,7 +14,7 @@ Futhermore, if you are not yet comfortable with downloading (only needs to be do
14
14
15
15
## The API
16
16
17
-
The best current documentation on the MCS API is the internals documentation [here](https://github.com/anthofflab/Mimi.jl/blob/master/docs/src/internals/montecarlo.md), which provides a working and informal description of the Monte Carlo Simulation support of Mimi. This file should be used in conjunction with the examples below for details, since the documentation covers more advanced options such as non-stochastic scenarios and running multiple models, which are not yet included in this tutorial.
17
+
The best current documentation on the MCS API is the internals documentation [here](https://github.com/mimiframework/Mimi.jl/blob/master/docs/src/internals/montecarlo.md), which provides a working and informal description of the Monte Carlo Simulation support of Mimi. This file should be used in conjunction with the examples below for details, since the documentation covers more advanced options such as non-stochastic scenarios and running multiple models, which are not yet included in this tutorial.
Copy file name to clipboardExpand all lines: docs/src/tutorials/tutorial_main.md
+2-2Lines changed: 2 additions & 2 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -1,6 +1,6 @@
1
1
# Introduction
2
2
3
-
The following tutorials target [Mimi](https://github.com/anthofflab/Mimi.jl) users of different experience levels, starting with first-time users. Before engaging with these tutorials, we recommend that users read the [Welcome to Mimi](@ref) documentation, including the [User Guide](@ref), 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](https://julialang.org/) language, though expertise is not required.
3
+
The following tutorials target [Mimi](https://github.com/mimiframework/Mimi.jl) users of different experience levels, starting with first-time users. Before engaging with these tutorials, we recommend that users read the [Welcome to Mimi](@ref) documentation, including the [User Guide](@ref), 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](https://julialang.org/) language, though expertise is not required.
4
4
5
5
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](https://forum.mimiframework.org). We welcome your feedback.
6
6
@@ -33,7 +33,7 @@ The following terminology is used throughout the documentation.
33
33
34
34
## Requirements and Initial Setup
35
35
36
-
These tutorials require [Julia v1.0.0](https://julialang.org/downloads/) and [Mimi v0.6.0](https://github.com/anthofflab/Mimi.jl), or later. You will also need to use [Github](https://github.com) and thus download [Git](https://git-scm.com/downloads).
36
+
These tutorials require [Julia v1.0.0](https://julialang.org/downloads/) and [Mimi v0.6.0](https://github.com/mimiframework/Mimi.jl), or later. You will also need to use [Github](https://github.com) and thus download [Git](https://git-scm.com/downloads).
37
37
38
38
To use the following tutorials, follow the steps below.
0 commit comments