From cf87a03dbaee6ccc2e0f0376ad18b07a14180467 Mon Sep 17 00:00:00 2001 From: lrennels Date: Thu, 22 Apr 2021 14:35:53 -0700 Subject: [PATCH] Add docs to ensure adding General Registry before Mimi Registry --- docs/src/tutorials/tutorial_1.md | 18 +++++++++++++----- docs/src/tutorials/tutorial_2.md | 2 +- docs/src/tutorials/tutorial_3.md | 2 +- docs/src/tutorials/tutorial_4.md | 2 +- docs/src/tutorials/tutorial_5.md | 2 +- docs/src/tutorials/tutorial_6.md | 2 +- 6 files changed, 18 insertions(+), 10 deletions(-) diff --git a/docs/src/tutorials/tutorial_1.md b/docs/src/tutorials/tutorial_1.md index 114c16ab4..a6764cd45 100644 --- a/docs/src/tutorials/tutorial_1.md +++ b/docs/src/tutorials/tutorial_1.md @@ -16,19 +16,27 @@ There are various editors around that have julia support, including the followin ## Installing Mimi -Once julia is installed, start julia and you should see a julia command prompt. To install the Mimi package, issue the following command from the Pkg REPL mode, which is entered by typing `]` and exited with a single backspace: +Once julia is installed, start julia and you should see a julia command prompt. Begin an interactive Julia session and enter the Package REPL, which is entered by typing `]` and exited with a single backspace: ```julia -pkg> add Mimi +julia> ] ``` -You only have to run this command once on your machine. -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 following command at the julia Pkg REPL: +Next you should run a command that updates your system with the latest information about available packages. It is particularly crucial that you run this command at this point if this is the first time you are using Julia on your system. To run this command, execute the following in the package REPL: ```julia pkg> update ``` -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. + +Now to install the Mimi package, issue the following command from the Pkg REPL mode: + +```julia +pkg> add Mimi +``` + +You only have to run this command once on your machine. + +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. ```julia pkg> update Mimi diff --git a/docs/src/tutorials/tutorial_2.md b/docs/src/tutorials/tutorial_2.md index bd6895dc9..4ec107405 100644 --- a/docs/src/tutorials/tutorial_2.md +++ b/docs/src/tutorials/tutorial_2.md @@ -8,7 +8,7 @@ Working through the following tutorial will require: - [Mimi v0.10.0](https://github.com/mimiframework/Mimi.jl) or higher - connection of your julia installation with the central Mimi registry of Mimi models -If you have not yet prepared these, go back to the first tutorial to set up your system. +**If you have not yet prepared these, go back to the first tutorial to set up your system.** Note that we have recently released Mimi v1.0.0, which is a breaking release and thus we cannot promise backwards compatibility with version lower than v1.0.0 although several of these tutorials may run properly with older versions. For assistance updating your own model to v1.0.0, or if you are curious about the primary changes made, see the How-to Guide on porting to Mimi v1.0.0. Mimi v0.10.0 is functionally dentical to Mimi v1.0.0, but includes deprecation warnings instead of errors to assist users in porting to v1.0.0. diff --git a/docs/src/tutorials/tutorial_3.md b/docs/src/tutorials/tutorial_3.md index c48381793..b6065518b 100644 --- a/docs/src/tutorials/tutorial_3.md +++ b/docs/src/tutorials/tutorial_3.md @@ -8,7 +8,7 @@ Working through the following tutorial will require: - [Mimi v0.10.0](https://github.com/mimiframework/Mimi.jl) or higher - connection of your julia installation with the central Mimi registry of Mimi models -If you have not yet prepared these, go back to the first tutorial to set up your system. +**If you have not yet prepared these, go back to the first tutorial to set up your system.** Note that we have recently released Mimi v1.0.0, which is a breaking release and thus we cannot promise backwards compatibility with version lower than v1.0.0 although several of these tutorials may run properly with older versions. For assistance updating your own model to v1.0.0, or if you are curious about the primary changes made, see the How-to Guide on porting to Mimi v1.0.0. Mimi v0.10.0 is functionally dentical to Mimi v1.0.0, but includes deprecation warnings instead of errors to assist users in porting to v1.0.0. diff --git a/docs/src/tutorials/tutorial_4.md b/docs/src/tutorials/tutorial_4.md index 405c02efc..3e8934a27 100644 --- a/docs/src/tutorials/tutorial_4.md +++ b/docs/src/tutorials/tutorial_4.md @@ -9,7 +9,7 @@ Working through the following tutorial will require: - [Julia v1.4.0](https://julialang.org/downloads/) or higher - [Mimi v0.10.0](https://github.com/mimiframework/Mimi.jl) or higher -If you have not yet prepared these, go back to the main tutorial page and follow the instructions for their download. +**If you have not yet prepared these, go back to the first tutorial to set up your system.** Note that we have recently released Mimi v1.0.0, which is a breaking release and thus we cannot promise backwards compatibility with version lower than v1.0.0 although several of these tutorials may run properly with older versions. For assistance updating your own model to v1.0.0, or if you are curious about the primary changes made, see the How-to Guide on porting to Mimi v1.0.0. Mimi v0.10.0 is functionally dentical to Mimi v1.0.0, but includes deprecation warnings instead of errors to assist users in porting to v1.0.0. diff --git a/docs/src/tutorials/tutorial_5.md b/docs/src/tutorials/tutorial_5.md index 2a29fdaf1..50408b693 100644 --- a/docs/src/tutorials/tutorial_5.md +++ b/docs/src/tutorials/tutorial_5.md @@ -9,7 +9,7 @@ Working through the following tutorial will require: - [Julia v1.4.0](https://julialang.org/downloads/) or higher - [Mimi v0.10.0](https://github.com/mimiframework/Mimi.jl) or higher -If you have not yet prepared these, go back to the main tutorial page and follow the instructions for their download. +**If you have not yet prepared these, go back to the first tutorial to set up your system.** Note that we have recently released Mimi v1.0.0, which is a breaking release and thus we cannot promise backwards compatibility with version lower than v1.0.0 although several of these tutorials may run properly with older versions. For assistance updating your own model to v1.0.0, or if you are curious about the primary changes made, see the How-to Guide on porting to Mimi v1.0.0. Mimi v0.10.0 is functionally dentical to Mimi v1.0.0, but includes deprecation warnings instead of errors to assist users in porting to v1.0.0. diff --git a/docs/src/tutorials/tutorial_6.md b/docs/src/tutorials/tutorial_6.md index 04a68a002..24e6210a2 100644 --- a/docs/src/tutorials/tutorial_6.md +++ b/docs/src/tutorials/tutorial_6.md @@ -7,4 +7,4 @@ Working through the following tutorial will require: - [Julia v1.4.0](https://julialang.org/downloads/) or higher - [Mimi v0.10.0](https://github.com/mimiframework/Mimi.jl) or higher -If you have not yet prepared these, go back to the main tutorial page and follow the instructions for their download. +**If you have not yet prepared these, go back to the first tutorial to set up your system.**