Skip to content

Commit fb5cb45

Browse files
Revise installation instructions for TrixiAtmo.jl
Updated README to reflect that TrixiAtmo.jl is now a registered Julia package and modified installation instructions accordingly.
1 parent 8d2c5da commit fb5cb45

File tree

1 file changed

+8
-13
lines changed

1 file changed

+8
-13
lines changed

README.md

Lines changed: 8 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -33,24 +33,19 @@ If you have not yet installed Julia, please [follow the instructions for your
3333
operating system](https://julialang.org/downloads/platform/). TrixiAtmo.jl works
3434
with Julia v1.10 and newer. We recommend using the latest stable release of Julia.
3535

36-
TrixiAtmo.jl is **not** a registered Julia package yet, and therefore needs to be
37-
downloaded manually and then run from within the cloned directory:
38-
```bash
39-
git clone https://github.com/trixi-framework/TrixiAtmo.jl.git
40-
julia --project=@.
41-
```
42-
In addition, TrixiAtmo.jl requires the numerical solver framework
43-
[Trixi.jl](https://github.com/trixi-framework/Trixi.jl), relevant sub-packages of
44-
[OrdinaryDiffEq.jl](https://github.com/SciML/OrdinaryDiffEq.jl) for time integration, and
45-
[Plots.jl](https://github.com/JuliaPlots/Plots.jl) for visualization, which can be
46-
installed by executing the following in the Julia REPL:
36+
TrixiAtmo.jl is a registered Julia package and can be installed using Julia's package manager.
37+
In addition, TrixiAtmo.jl requires the numerical solver framework
38+
[Trixi.jl](https://github.com/trixi-framework/Trixi.jl) as well as relevant sub-packages of
39+
[OrdinaryDiffEq.jl](https://github.com/SciML/OrdinaryDiffEq.jl) for time integration. Executing the
40+
following in the Julia REPL will install the packages required to run the cases in the `examples`
41+
directory, along with [Trixi2Vtk.jl](https://github.com/trixi-framework/Trixi2Vtk.jl), which enables
42+
visualization of the resulting HDF5-based output files:
4743
```julia
4844
julia> using Pkg
4945

50-
julia> Pkg.add(["Trixi", "Trixi2Vtk", "OrdinaryDiffEqLowStorageRK", "OrdinaryDiffEqSSPRK", "Plots"])
46+
julia> Pkg.add(["TrixiAtmo", "Trixi", "OrdinaryDiffEqLowStorageRK", "OrdinaryDiffEqSSPRK", "Trixi2Vtk"])
5147
```
5248

53-
5449
## Usage
5550

5651
In the Julia REPL, first load the package Trixi.jl

0 commit comments

Comments
 (0)