From bbc63ba500b087cf65055b6a1ec8dfe0f5be48f2 Mon Sep 17 00:00:00 2001 From: lrennels Date: Fri, 24 May 2019 20:27:13 -0700 Subject: [PATCH 1/2] Update readme --- README.md | 62 ++++++----------------------------------------- docs/src/index.md | 5 ++-- 2 files changed, 10 insertions(+), 57 deletions(-) diff --git a/README.md b/README.md index 1afcba3ed..9e4775b18 100644 --- a/README.md +++ b/README.md @@ -1,70 +1,24 @@ [![Build Status](https://travis-ci.org/mimiframework/Mimi.jl.svg?branch=master)](https://travis-ci.org/mimiframework/Mimi.jl) [![Build status](https://ci.appveyor.com/api/projects/status/f915ntkc0etgvim9/branch/master?svg=true)](https://ci.appveyor.com/project/mimiframework/mimi-jl/branch/master) [![codecov](https://codecov.io/gh/mimiframework/Mimi.jl/branch/master/graph/badge.svg)](https://codecov.io/gh/mimiframework/Mimi.jl) - [![Stable documentation](https://img.shields.io/badge/docs-stable-blue.svg)](https://www.mimiframework.org/Mimi.jl/stable) -[![Latest documentation](https://img.shields.io/badge/docs-latest-blue.svg)](https://www.mimiframework.org/Mimi.jl/dev/) # Mimi - Integrated Assessment Modeling Framework -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/)**. - -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. - -## Overview - -Mimi is a package that provides a component model for integrated assessment models. - -Also see the [OptiMimi](http://github.com/jrising/OptiMimi.jl) package for optimizing parameters within Mimi models. - -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. - -[Julia 1.0](https://julialang.org/blog/2018/08/one-point-zero): Mimi has now been ported to Julia 1.0. - -## Installation - -Mimi is an installable package. To install Mimi, first enter Pkg REPL mode by typing `]`, and then use the following: - -```julia -pkg> add Mimi -``` - -You may then exit Pkg REPL mode with a single backpace. - -## Mimi Registry - -Several models currently use the Mimi framework, as listed in the section below. For convenience, several models are registered in the [MimiRegistry](https://github.com/mimiframework/Mimi.jl), and operate as julia packages. To use this feature, 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: - -```julia -pkg> registry add https://github.com/mimiframework/MimiRegistry.git -``` +Mimi is a [Julia](http://julialang.org) package that provides a component model for [integrated assessment models](https://en.wikipedia.org/wiki/Integrated_assessment_modelling), as described in detail on the **[Mimi Framework Homepage](https://www.mimiframework.org)**. For more information on the package functionality, installation, the Mimi registry, and step-by-step tutorials, see the **[Documentation](https://www.mimiframework.org/Mimi.jl/stable/)**. -You only need to run this command once on a computer. +## Updates -From there you may add any of the registered packages, such as MimiRICE2010.jl by running the following command at the julia package REPL: +* Also see the [OptiMimi](http://github.com/jrising/OptiMimi.jl) package for optimizing parameters within Mimi models. -```julia -pkg> add MimiRICE2010 -``` -## Models using Mimi +* 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. -* [MimiFUND.jl](https://github.com/fund-model/MimiFUND.jl) -* [MimiDICE2010.jl](https://github.com/anthofflab/MimiDICE2010.jl) -* [MimiDICE2013.jl](https://github.com/anthofflab/MimiDICE2013.jl) -* [MimiRICE2010.jl](https://github.com/anthofflab/MimiRICE2010.jl) -* [Mimi-SNEASY.jl](https://github.com/anthofflab/mimi-sneasy.jl) (currently in closed beta) -* [Mimi-FAIR.jl](https://github.com/anthofflab/mimi-fair.jl) (currently in closed beta) -* [MimiPAGE2009.jl](https://github.com/anthofflab/MimiPAGE2009.jl) -* [Mimi-MAGICC.jl](https://github.com/anthofflab/mimi-magicc.jl) (CH4 parts currently in closed beta) -* [Mimi-HECTOR.jl](https://github.com/anthofflab/mimi-hector.jl) (CH4 parts currently in closed beta) -* [Mimi-CIAM.jl](https://github.com/anthofflab/mimi-ciam.jl) (currently in closed beta) -* [Mimi-BRICK.jl](https://github.com/anthofflab/mimi-brick.jl) (currently in closed beta) -* [AWASH](http://awashmodel.org/) -* [PAGE-ICE](https://github.com/openmodels/PAGE-ICE) +* [Julia 1.0](https://julialang.org/blog/2018/08/one-point-zero): Mimi has now been ported to Julia 1.0. -## Contributing +## Contributions and Questions -Contributions to Mimi are most welcome! You can interact with the Mimi development team via issues and pull requests here on github, and in the [Mimi Framework forum](https://forum.mimiframework.org). +You can interact with the Mimi development team via issues and pull requests here on github, and in the [Mimi Framework forum](https://forum.mimiframework.org). Contributions to Mimi are also most welcome, and +please get in touch with [David Anthoff](http://www.david-anthoff.com) if you are want to be involved in any way with this effort. ## Acknowledgements diff --git a/docs/src/index.md b/docs/src/index.md index bcf315d73..0682afe50 100644 --- a/docs/src/index.md +++ b/docs/src/index.md @@ -6,13 +6,12 @@ Mimi is a package that provides a component model for [integrated assessment mod ## Installation -Mimi is an installable package. To install Mimi, first enter Pkg REPL mode by typing `]`, and then use the following: +Mimi is an installable package which requires the programming language [julia](http://julialang.org/) to run. To install Mimi, first enter Pkg REPL mode by typing `]`, and then use the following script. You may then exit Pkg REPL mode with a single backpace. ```julia pkg> add Mimi ``` - -You may then exit Pkg REPL mode with a single backpace. For more complete setup instructions, follow the [Installation Guide](@ref). +For more complete setup instructions, follow the [Installation Guide](@ref). ## Mimi Registry From 46ffda18999a8c03d8d6e816bf3fa05614b6033b Mon Sep 17 00:00:00 2001 From: lrennels Date: Mon, 27 May 2019 08:41:44 -0700 Subject: [PATCH 2/2] Simplify readme --- README.md | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/README.md b/README.md index 9e4775b18..8cafc6974 100644 --- a/README.md +++ b/README.md @@ -5,11 +5,11 @@ # Mimi - Integrated Assessment Modeling Framework -Mimi is a [Julia](http://julialang.org) package that provides a component model for [integrated assessment models](https://en.wikipedia.org/wiki/Integrated_assessment_modelling), as described in detail on the **[Mimi Framework Homepage](https://www.mimiframework.org)**. For more information on the package functionality, installation, the Mimi registry, and step-by-step tutorials, see the **[Documentation](https://www.mimiframework.org/Mimi.jl/stable/)**. +Mimi is a [Julia](http://julialang.org) package that provides a component model for [integrated assessment models](https://en.wikipedia.org/wiki/Integrated_assessment_modelling), as described in detail on the [Mimi Framework Homepage](https://www.mimiframework.org). The [Documentation](https://www.mimiframework.org/Mimi.jl/stable/) includes information on the installation and use of this package, as well as details on the Mimi registry and step-by-step tutorials which users of different experience levels, starting with first-time users. The development team closely monitors the [Mimi Framework forum](https://forum.mimiframework.org) and we suggest this as a starting place for any questoins users may have. ## Updates -* Also see the [OptiMimi](http://github.com/jrising/OptiMimi.jl) package for optimizing parameters within Mimi models. +* [OptiMimi](http://github.com/jrising/OptiMimi.jl): See this package for optimizing parameters within Mimi models. * 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.