Skip to content

jwasikpsnc/IBEX

 
 

Repository files navigation

IBEX

IBEX (IMAS variaBles EXplorer) is a general purpose graphical tool for exploring the content of IMAS structured data. It can display quantities as 1D or 2D plots (possibly slicing through higher dimensionality datasets). It is expected to replace IMASViz (which is not maintained anymore) and go beyond.

Note

This project is under active development, important changes may occur including in the backend endpoint API.

Frontend readme

Backend readme

Quick Start

Prerequisites

  • Python 3.9+
  • Node.js 16+

Installation & Build

git clone <ibex_repo>
cd ibex/backend
python -m venv ibex_venv
source ibex_venv/bin/activate
pip install .

cd ../frontend
npm install
npm run package

Run IBEX

./out/ibex-linux-x64/ibex

Developer Installation

installation on SDCC

    git clone <ibex_repo>
    cd ibex
    
    # this script packs frontend and prepares site-packages with backend
    ./install.sh

    # test if it runs successfully
    ./frontend/out/ibex-linux-x64/ibex

Run IBEX on SDCC

    # first you have to install ibex as shown in step "Central installation on SDCC"
    ./<ibex_repo>/launch.sh

Development run

    git clone <ibex_repo>
    cd ibex
    
    # this script creates venv, installs python package in editable mode and runs fronend
    ./launch-dev.sh

About

IMAS variaBles EXplorer

Resources

License

Code of conduct

Contributing

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published

Languages

  • TypeScript 74.4%
  • Python 22.4%
  • Shell 2.7%
  • Other 0.5%