install.md

OpenSOAP Installation Guide

New to Julia?

If you are new to the Julia programming language, follow these steps to install the language:

1. Install Julia for your OS from this page. a. There's a good list of language tutorials here.
2. Try running the Julia Read/Evaluate/Print Loop (REPL) from your terminal like this:

julia

Setting up this project

Tip

The following assumes a Linux or macOS operating system for file path syntax. If you are on Windows, replace / with \\ in file paths for compatibility.

Find a folder on your computer you want to store this work in. Navigate there in the terminal. When you've arrived, do:

git clone --recursive https://github.com/thanasipantazides/OpenSOAP.git
cd OpenSOAP

From here, you should start Julia using the OpenSOAP project environment:

julia --project=.

Then, at the Julia REPL, press ] to enter the package manager, and activate the local environment:

julia> ]
pkg> activate .

Now install all required packages:

pkg> instantiate

This may take a few minutes. When complete, press backspace/delete to return to the main Julia REPL.

Once complete, try running the test simulation and displaying plots with:

julia> include("test/plot.jl")

Finally, to open/run the test simulation:

julia> plot_main()

Building documentation

Tip

The following assumes a Linux or macOS operating system for file path syntax. If you are on Windows, replace / with \\ in file paths for compatibility.

Navigate to the docs folder, and start the local Julia environment:

cd OpenSOAP/docs
julia --project=.

Then, at the Julia REPL, press ] to enter the package manager, and activate the local environment:

julia> ]
pkg> activate .

Include the OpenSOAP package as a dependency:

pkg> dev ..

Press backspace/delete to exit the package manager and return to the main Julia REPL. Finally, build the documentation like this:

julia> include("make.jl")

The PDF document will appear in OpenSOAP/docs/build/.