YAPTIDE Developer Docs

Welcome to the YAPTIDE developer documentation! Here you can find guides and resources for setting up a development environment, understanding the architecture, and contributing to the project. The source code is hosted on GitHub.

To learn how to use the app, see the user documentation.

How YAPTIDE Works

YAPTIDE has three execution modes. You don’t need the full stack for every one.

Mode	What you can do	What you need
Demo	Edit geometry, generate input files, run Geant4 in-browser	Just a browser
Celery (direct)	Submit SHIELD-HIT12A / FLUKA jobs to local workers	Docker stack or local backend + Redis
Batch (SLURM)	Submit to HPC clusters (e.g. PLGrid Ares)	Full stack + Keycloak + cluster access

Setup

Before you begin, choose your setup method:

	Docker	Local
Best for	Quick start, testing	Active development
Requires	Docker Desktop	Node, Python, etc.
Setup time	Faster	Longer
Live reload	❌	✅

Frontend Demo

Quick start with no backend needed. Set up via Local or Docker.

Full Stack

Backend services and Celery workers included. Set up via Local or Docker.

HPC / Slurm

Full stack with SLURM cluster integration. Set up via Local or Docker.

Learn about the architecture

System Overview Understand the main architectural components and how they work together.

Backend Overview API contracts, Celery workers, and persistence model.

Frontend Overview 3D editor, Pyodide converter, and Wasm runtime.