Install everything

OEDI-SI spans three repositories. This page covers a full local install of all of them. For the shortest path to a running app, see the quickstart.

Prerequisites¶

1. The framework and CLI (oedisi)¶

pip install oedisi
oedisi --help          # verify the CLI is on your PATH

This installs the component framework, the oedisi.types data models, and the oedisi command-line tool. It also pulls in the HELICS Python bindings.

2. The HELICS runtime¶

Simulations are launched with the helics run command and coordinated by the helics_broker binary. Install both:

pip install "helics[cli]" helics-apps
helics --version       # verify
helics run --help      # verify the launcher

3. The components (oedisi-components)¶

git clone https://github.com/openEDI/oedisi-components.git
cd oedisi-components
git submodule update --init --recursive   # pulls the external algorithm components

Tell OEDISI where the components live by pointing OEDISI_COMPONENTS at the Components/ directory:

export OEDISI_COMPONENTS="$(pwd)/Components"

4. The web app (oedisi-frontend-app)¶

git clone https://github.com/openEDI/oedisi-frontend-app.git
cd oedisi-frontend-app
npm install
uv --directory server sync
npm run dev:all

Then open http://localhost:5173.

Version compatibility¶

Verify your install¶

oedisi --help          # framework CLI
helics run --help      # HELICS launcher
echo "$OEDISI_COMPONENTS"   # should print the Components/ path

With all four in place, continue to the UI tour or run the quickstart template.