Quick Start

This tutorial is for those already familiar with Julia, Git, Docker and / or Amazon AWS EC2.

Table of Contents

• Using Git and PC
• Using Docker
• Using Cloud: AWS EC2 with Docker

Using Git and PC

Download data from RWCodeData to RWCodeLocal directory.

RWCodeLocal/
├── Data/                   # Data downloaded from RWCodeData
    └── ...                
├── Guesses/                # Data downloaded from RWCodeData
    └── ...
├── Results/                # Empty folder for saving output results
└── RWCode/                 # Code from RWCode.jl
    └── src/
        └── functions/
        └── ...     

Start your Julia session from the CLI with 12+ threads:

julia +1.10 -t 12

Pull the package into the RWCodeLocal directory:

julia> cd("path/to/RWCodeLocal")

julia> VERSION
v"1.10.5"

julia> ] 

(@v1.10) pkg> add https://github.com/vrg2121/RWCode.jl

Activate the directory environment:

julia> cd("./RWCode")

julia> ]

pkg> activate .

pkg> instantiate

julia> using RWCode

Set up model inputs:

• See Model Configuration for more information about config options.

julia> D = "FULL/PATH/TO/DATA"
"FULL/PATH/TO/DATA"

julia> G = "FULL/PATH/TO/Guesses"
"FULL/PATH/TO/Guesses"

julia> R = "FULL/PATH/TO/Results"
"FULL/PATH/TO?Results"

julia> config = ModelConfig()

Run the model:

julia> run_rwcode(config, D, G, R)

Using Docker

Retrieve the docker image and run interactively:

docker run -it vrg2121/rwcode /bin/bash

Start up julia with multithreading:

• From the terminal / CLI...

julia -t 12

julia> ]

pkg> activate .

julia> using RWCode

Set up model inputs:

julia> D = "/home/jl/Data"

julia> G = "/home/jl/Guesses"

julia> R = "/home/jl/Results"

julia> config = ModelConfig()

Run the model:

julia> run_rwcode(config, D, G, R)

Using Cloud: AWS EC2 with Docker

Initialize an EC2 instance with at least 8 CPUs.

Load Docker onto the EC2 instance.

Follow the Quick Start using Docker guide.

Retrieve the outputs from EC2.