Package Guide

To work with the OAR project, you should know:

• How to install the package
• An overview of the project
• How to run experiments

Installation

Because it is an experimental research repository, the OAR package is not registered on JuliaHub. To set Julia component the project up, you must:

• Download a Julia distribution and install it on your system
• Git clone this repository or download a zip.
• Run julia within the top of the OAR directory, and run the following commands to instantiate the package:

julia> ]
(@v1.9) pkg> activate .
(OAR) pkg> instantiate

This will download all of the dependencies of the project and precompile where possible.

Overview

The OAR project is mainly a Julia programming language research project, so it is not designed as a package for use and installation through JuliaHub as other packages are. However, the main driver libraries of the project are bundled into a OAR module, so this module is loaded in the preamble of all experiments as a concise way of loading common code.

The project utilizes DrWatson for workflow utilities such as directory operations, results saving/loading, and simulation configurations. The file structure of this project differs slightly from the DrWatson default setup, so extra utilities are used for pointing to the correct source data directory and destination results directory according to each experiment.

In addition to the Julia components, some experiments are written in Python and Rust.

Each experiment contains a README outlining the setup and usage of the experiment such as in the setup of custom Python environments and in the running of parallel and distibuted experiments.

Experiments

To run an Julia experiment, setup the OAR project on your target system and run the experiment either in an interactive session with include(...):

include("scripts/1_iris/gramart.jl")

or from a terminal command line (from the top of the project directory):

julia --project=. scripts/1_iris/gramart.jl