From 792fc6c3d62aeb07cc150b1b3239051c58c3fc53 Mon Sep 17 00:00:00 2001 From: lbonaldo Date: Mon, 23 Sep 2024 11:50:40 -0400 Subject: [PATCH] Update Julia version requirements and recommendations --- README.md | 3 ++- docs/src/installation.md | 2 +- 2 files changed, 3 insertions(+), 2 deletions(-) diff --git a/README.md b/README.md index e72025805..e6ce3b87a 100644 --- a/README.md +++ b/README.md @@ -40,7 +40,8 @@ The 'main' branch is the current master branch of GenX. The various subdirectori ## Requirements -GenX (v0.4.1) runs on Julia v1.6 through v1.10, with a minimum version of the package JuMP v1.1.1. We recommend the users to either stick to a particular version of Julia to run GenX. If however, the users decide to switch between versions, it's very important to delete the old `Manifest.toml` file and do a fresh build of GenX when switching between Julia versions. +GenX (v0.4.1) runs on Julia v1.6 through v1.9, with a minimum version of the package JuMP v1.1.1. Julia v1.10 is also supported. However, we recently noticed a decline in performance with Julia v1.10, which is currently under investigation. Therefore, **we recommend using Julia v1.9**, particularly for very large cases. +We recommend the users to either stick to a particular version of Julia to run GenX. If however, the users decide to switch between versions, it's very important to delete the old `Manifest.toml` file and do a fresh build of GenX when switching between Julia versions. There is also an older version of GenX, which is also currently maintained and runs on Julia 1.3.x and 1.4.x series. For those users who has previously cloned GenX, and has been running it successfully so far, diff --git a/docs/src/installation.md b/docs/src/installation.md index 4d24f0927..3fb13ee36 100644 --- a/docs/src/installation.md +++ b/docs/src/installation.md @@ -2,7 +2,7 @@ This guide will walk you through the steps to install Julia, the GenX package, and the required dependencies to run GenX. ## Installing Julia -GenX (v0.4.1) runs on Julia v1.6 through v1.10, with a minimum version of the package [JuMP](https://jump.dev/JuMP.jl/stable/) v1.1.1. To install Julia, please follow the instructions on the [Julia website](https://julialang.org/downloads/). +GenX (v0.4.1) runs on Julia v1.6 through v1.9, with a minimum version of the package [JuMP](https://jump.dev/JuMP.jl/stable/) v1.1.1. Julia v1.10 is also supported. However, we recently noticed a decline in performance with Julia v1.10, which is currently under investigation. Therefore, we recommend using Julia v1.9, particularly for very large cases. To install Julia, please follow the instructions on the [Julia website](https://julialang.org/downloads/). !!! note "Note" We recommend the users to stick to a particular version of Julia to run GenX. If however, the users decide to switch between versions, it's very important to delete the old `Manifest.toml` file and do a fresh build of GenX.