windscope

this repository contains scripts and helpers for the windscope exhibit

about windscope

A collaborative and interactive wind farm simulator. This project was done during the summer semester 2023 at ifgi. This project is based on the existing future mobility project from Imaginary and adapted it towards the aim of this project. Read more about it on the windpark-simulator repository

relevant repos

• scanner
  • forked from CityScoPy
• app

architecture

relies on mise-en-place for easier dev setup and deployment

flowchart TB
    subgraph scanner
        direction LR
        cam(camera feed)
        keystones[(keystones.txt)]
        cam -.optional.-> calibrate{calibrate.py}
        cam --> scanner_api{run.py}
        calibrate --> keystones
        keystones --> scanner_api
    end
    subgraph app
        direction LR
        api{server} --sends json to socket\n:4848--> frontend{"frontend"}
        frontend --serves app on \n:8080--> browser
    end
    scanner_api --sends json to socket\n:5000--> api
    browser --application capture--> obs{OBS}
    obs --fullscreen projection\n(HDMI)--> beamer@{ shape: win-pane, label: "beamer" }
    browser --displays\n(DP)--> main_display(display-1)

Loading

setup the project from a clean system

Caution

TBD

git clone --recurse-submodules https://github.com/dokxid/windscope.git
cd windscope
./create-user.sh  # needed if u want a kiosk user
./setup.sh

start the server

Tip

i would suggest using 3 separate terminal windows/tabs for every mise task

mise run
# a shell alias is defined for `run` to be aliased to `mise run`, so you can also run:
run

and now select the task you want

 $ run
Tasks
Select a task to run
❯ calibrate  calibrate the scanner camera
  frontend   serve the simulator frontend
  scanner    start the scanner
  simulator  start the simulator API
↑/↓/k/j up/down • / filter • enter confirm