Skip to content

Commit

Permalink
update some docs
Browse files Browse the repository at this point in the history
  • Loading branch information
lmiq committed Dec 3, 2023
1 parent e030cd3 commit d29492f
Show file tree
Hide file tree
Showing 2 changed files with 12 additions and 18 deletions.
14 changes: 8 additions & 6 deletions docs/src/installation.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,14 +8,16 @@

## Install Julia

First you need to install the Julia language in your platform, from:
[http://julialang.org](http://julialang.org). Julia version 1.6 or greater is required. Using the [juliaup](https://github.com/JuliaLang/juliaup) tool is also a highly recommended way of installing and keeping Julia up to date.
First you need to install the Julia language, version 1.9 or greater is required.
Using the [juliaup](https://github.com/JuliaLang/juliaup) tool is a highly recommended way of installing and keeping Julia up to date.

!!! tip
New to Julia? Julia is a modern high-level yet performant programming language. Some tips
and a nice workflow for using it effectively can be found [here](https://m3g.github.io/JuliaNotes.jl/stable/workflow/).
Alternatively, you can install Julia by downloading the binaries directly from [the Julia webpage](https://julialang.org).

!!! note
New to Julia? Julia is a modern high-level yet performant programming language. Some tips
and a nice workflow for using it effectively can be found [here](https://m3g.github.io/JuliaNotes.jl/stable/workflow/).

For this specific package, following a the step-by-step examples provided here after installing Julia should be enough.
For this specific package, following a the step-by-step examples provided here after installing Julia should be enough.

## Install the packages

Expand Down
16 changes: 4 additions & 12 deletions docs/src/quickguide.md
Original file line number Diff line number Diff line change
Expand Up @@ -63,18 +63,10 @@ julia -t auto example.jl
where `-t auto` will launch `julia` with multi-threading. It is highly recommended to use multi-threading!

!!! note
Julia compiles the code the first time it is run in each section. Thus, running script from the command line with, for example, `julia -t auto example.jl` may appear slow, particularly if you are modifying the script interactively. Ideally, *do not restart Julia*, just repeatedly include your script in the same Julia section. The second time the script is loaded will be much faster. For example:
```julia-repl
julia> @time include("./example.jl")
# ... some output
27.554095 seconds (72.13 M allocations: 4.623 GiB, 4.37% gc time, 11.96% compilation time)
julia> @time include("./example.jl")
# ... some output
0.703780 seconds (3.24 M allocations: 897.260 MiB, 12.22% gc time)
```
The first time the script was called it took ~30s, which included compilation of the code and loading of the packages. The second time the script was included it took 0.7s. Thus, for interactive modification of the script, don't restart Julia.

This has been much improved in Julia 1.9, particularly if a stable environment is used, as suggested.
Some newer CPUs have "fast" and "slow" cores, designed for performance or energy savings. Thus
using all cores, with `-t auto`, may not be the best strategy for optimal performance. Experimenting
with different number of cores using `-t N` where `N` is the number of cores used is always necessary
for tunning performance.

## Detailed description of the example

Expand Down

0 comments on commit d29492f

Please sign in to comment.