Skip to content

Commit 73ab92d

Browse files
authored
Merge pull request #776 from GenXProject/docs/update_readme
Update Julia version requirements and recommendations
2 parents 150fe7a + 792fc6c commit 73ab92d

File tree

2 files changed

+3
-2
lines changed

2 files changed

+3
-2
lines changed

README.md

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -40,7 +40,8 @@ The 'main' branch is the current master branch of GenX. The various subdirectori
4040

4141
## Requirements
4242

43-
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.
43+
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.
44+
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.
4445

4546
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.
4647
For those users who has previously cloned GenX, and has been running it successfully so far,

docs/src/installation.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@
22
This guide will walk you through the steps to install Julia, the GenX package, and the required dependencies to run GenX.
33

44
## Installing Julia
5-
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/).
5+
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/).
66

77
!!! note "Note"
88
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.

0 commit comments

Comments
 (0)