Getting Started

Installation

Method 1

Download the setup script InitialSetup.jl. Then open a Julia session and run:

julia> require("InitialSetUp.jl")

This script will install and load the SnFFT library and then run the examples.

Method 2

SnFFT can also be installed using Julia’s pakage manager as follows:

julia> Pkg.add("SnFFT")

Set Up

After the installation, the user can load the library with:

julia> using SnFFT

By default, lower level functions in the source code are not made available during installation. These functions are often wrapper or helper functions that may not be relevant to most users. However, these internal functions can be made available by modifying the file SnFFT.jl.

Parallelism

SnFFT allows the user to compute fast Fourier transforms and inverse fast Fourier transforms in parralel with no change to their code. On startup, simply run:

julia> addprocs(p)
julia> using SnFFT

This will and p worker processes and load the SnFFT library onto them. Afterwards, parts of SnFFT will automatically run in parallel, if their heuristics think say that it will be beneficial.