SIAM_fTN

This code base is using the Julia Language and DrWatson to make a reproducible scientific project named

SIAM_fTN

To (locally) reproduce this project, do the following:

0. Download this code base. Notice that raw data are typically not included in the git-history and may need to be downloaded independently.
1. Open a Julia console and do:

   julia> using Pkg
   julia> Pkg.add("DrWatson") # install globally, for using `quickactivate`
   julia> Pkg.activate("path/to/this/project")
   julia> Pkg.instantiate()
   

This will install all necessary packages for you to be able to run the scripts and everything should work out of the box, including correctly finding local paths.

Running the code

Specify the parameters of the simulation in params.yml (located one directory above src/). In Julia, do

julia> using DrWatson
julia> @quickactivate "SIAM_fTN"
julia> include("./src/main.jl")

Given Julia's JIT compilation, we recommend that the first run be done with simple parameters (ie, two timesteps) so that the relevant functions can be compiled. Running the code is done with

julia> main()

with the results being output in the data/ directory.