Skip to content

Commit 030bfa0

Browse files
authored
Update README.md
1 parent 94c3875 commit 030bfa0

File tree

1 file changed

+16
-0
lines changed

1 file changed

+16
-0
lines changed

README.md

Lines changed: 16 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -14,6 +14,22 @@ Currently, the package focuses on non-conservative form of the advection terms (
1414

1515
The core of the package is written in pure Julia, focusing on performance using CPUs but GPU support is available using KernelAbstractions.jl and Chmy.jl via 2 separate extensions.
1616

17+
## Installation
18+
19+
FiniteDiffWENO5.jl is a registered Julia package and can be installed directly using the package manager:
20+
21+
```julia-repl
22+
julia>]
23+
pkg> add FiniteDiffWENO5
24+
```
25+
26+
And you can test the package with:
27+
28+
```julia-repl
29+
julia>]
30+
pkg> test FiniteDiffWENO5
31+
```
32+
1733
## Features
1834

1935
The package currently exports only two main functions: `WENOScheme()`, that is used to create a WENO scheme struct containing all the necessary information for the WENO method, and `WENO_step!()`, that performs one step of the time integration using the WENO-Z method and a 3rd-order Runge-Kutta method. The grid and the initial condition must be defined by the user.

0 commit comments

Comments
 (0)