Quick Start (10 Minutes)

Use this guide if you want to run OptArrow today with minimum setup.

1) Clone the source repository

git clone git@github.com:optArrow/optArrow.git
cd optArrow
git checkout main

2) Install dependencies

pipx install poetry
poetry install --no-root
julia --project=./src/service/optimization_service/julia -e "import Pkg; Pkg.instantiate()"

3) Start services

./scripts/startAll.sh

Expected open ports include 8000 (gateway), 8101 (Python engine), and 65432 (Julia engine).

Verify ports explicitly:

nc -zv 127.0.0.1 8000 8101 65432

4) Send your first request

Use the full runnable example in:

LP Example: Production Optimization
MATLAB Interface if you want to call the gateway from MATLAB

5) Verify success

Run a minimal JSON smoke test:

curl -i -X POST http://127.0.0.1:8000/computeJSON \
  -H "Content-Type: application/json" \
  -d '{"model":{"A":{"row":[0],"col":[0],"val":[1.0]},"b":[1.0],"c":[1.0],"lb":[0.0],"csense":["E"],"osense":"max"},"model_name":"smoke_test","engine":"julia","solver":{"solver_name":"HiGHS","solver_type":"LP","solver_params":{}}}'

Expected output:

HTTP status 200
Response JSON contains solver status and a solution payload

If you plan to use MATLAB (R2023b or later), the next step after the gateway smoke test is to:

Build and install the MATLAB Interface to Apache Arrow — see MATLAB Interface to Apache Arrow in the MATLAB Interface guide. This is a one-time step.

Add src/matlab to the MATLAB path and configure the client:

addpath(genpath(fullfile('<repo_root>', 'src', 'matlab')));
optarrow.setOptArrowConfig(struct( ...
    'endpoint',      'http://127.0.0.1:8000/compute', ...
    'backendSolver', 'HiGHS'));

See MATLAB Interface for OptArrow for LP/QP examples and the full configuration reference.

Troubleshooting

If startup fails, verify dependencies and listening ports:

poetry install --no-root
julia --project=./src/service/optimization_service/julia -e "import Pkg; Pkg.instantiate()"
ss -ltnp | grep -E ':8000|:8101|:65432'

If request fails, confirm endpoint and content type:

curl -i http://127.0.0.1:8000/
curl -i -X POST http://127.0.0.1:8000/computeJSON -H "Content-Type: application/json" -d '{}'