Skip to content

Commit

Permalink
Merge pull request #58 from ArrogantGao/xz/julia_readme
Browse files Browse the repository at this point in the history
update julia readme
  • Loading branch information
lu1and10 authored Aug 23, 2024
2 parents c26c19b + 7a54c9b commit 437d508
Showing 1 changed file with 18 additions and 3 deletions.
21 changes: 18 additions & 3 deletions julia/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,21 +6,36 @@ Flatiron Institute's `FMM3D` library.

## Using FMM3D.jl

For now, FMM3D.jl can be obtained by downloading this
`FMM3D.jl` is now registered in the Julia General registry, so you can install it in Julia 1.6 or later.
Press `]` in Julia REPL to enter the package manager and then enter:
```julia
pkg> add FMM3D
```
then the package should be installed automatically.

You can then use the package with

```julia
julia> using FMM3D
```

It can also be obtained by downloading this
git repository and a recent version of julia
(1.6 or later is required). Then, from the
root directory (the parent directory of the
julia subdirectory) run the following in
julia:

```julia
Pkg.add(url=".",subdir="julia")
julia> using Pkg

julia> Pkg.add(url=".",subdir="julia")
```

You can test the package with

```julia
Pkg.test("FMM3D")
julia> Pkg.test("FMM3D")
```

## Contributing
Expand Down

0 comments on commit 437d508

Please sign in to comment.