Skip to content

Commit 0475cee

Browse files
authored
Merge pull request #36 from byuflowlab/docs
Docs
2 parents 2b0dd13 + 75539fb commit 0475cee

2 files changed

Lines changed: 17 additions & 0 deletions

File tree

docs/src/guided.md

Lines changed: 9 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,14 @@
11
# Guided Examples
22

3+
## CPU Parallelization
4+
5+
To enable CPU parallelization, merely launch Julia with multiple threads and run your code as usual:
6+
7+
```bash
8+
julia --threads=auto
9+
```
10+
The [FastMultipole.jl](https://flow.byu.edu/FastMultipole.jl/dev/) backend will automatically take advantage of the available threads.
11+
312
## Vortex Ring
413
```@example ring
514
using FLOWVPM

docs/src/index.md

Lines changed: 8 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -14,6 +14,14 @@ Furthermore, rVPM is highly efficient since it uses computational elements only
1414
FLOWVPM is implemented in Julia, which is a modern, high-level, dynamic programming language for high-performance computing.
1515
[Paraview](https://www.paraview.org/) is recommended for visualization of simulations.
1616

17+
## Installation
18+
19+
Install using Julia's package manager as:
20+
21+
```@julia-repl
22+
] add https://github.com/byuflowlab/FLOWVPM.jl.git
23+
```
24+
1725
## Features
1826
* Fast-multipole acceleration through FastMultipole.jl
1927
* Threaded CPU parallelization through OpenMP

0 commit comments

Comments
 (0)