Getting started

This page outlines requirements and installation steps for the code. Currently, GNU/Linux and MacOS (including ARM) are supported.

Software requirements

Warning

Do not install Julia using your system package manager. Install only from julialang.org as below.

Installation

Install Julia's package manager (Mac and Linux):
```
curl -fsSL https://install.julialang.org | sh
```

Clone the repo

git clone https://github.com/FormingWorlds/Obliqua.git

Move to the repository directory
```
cd Obliqua
```
Open Julia package manager
```
julia
```
Install Obliqua
```
julia> ]
pkg> add .
```

Testing

If you want to run the tests manually, simply use the script located in the test/ folder. Run the follwoing command from the Obliqua root directory:

julia --project test/runtests.jl

This will print information on whether tests passed or failed.