rappture2web documentation

rappture2web turns Rappture tool XML definitions into interactive web applications — no desktop GUI required.

It reads a tool.xml file, renders the input form in a browser, runs the simulation backend, and displays the output visualizations (curves, fields, tables, maps, and more) in real time over WebSocket.

Getting Started

• Installation
  • Requirements
  • Install from PyPI
  • Install from source
  • Dependencies
  • NanoHUB deployment
• Quick Start
  • Running a tool
  • Command-line options
  • Creating a minimal tool
  • Classic vs. library mode
• tool.xml Reference
  • Root structure
  • The <tool> section
  • The <input> section
  • The <output> section

User Guide

• Operating Modes
  • Classic mode (default)
  • Library mode
  • Choosing a mode
• Input Types
  • Number
  • Integer
  • Boolean
  • String
  • Choice
  • Multichoice
  • Loader
  • Group
  • Phase
  • Note
  • Structure
  • Periodic Element
  • Drawing
  • Separator
• Output Types
  • Curve
  • Histogram
  • Field
  • Table
  • Sequence
  • Image
  • Number / Integer / String / Boolean
  • Log
  • Mapviewer
• Uncertainty Quantification (UQ)
  • Enabling UQ
  • Opting out individual inputs
  • Distribution types
  • How it works
  • PUQ integration
  • Library mode UQ
  • Example
• Run History
  • Viewing past runs
  • Caching
  • REST API

Examples

• Examples
  • Available examples

API Reference

• rp_library — Rappture Python Library
  • Quick start
  • PyXml interface
  • library() interface
  • Units conversion
  • Progress reporting
  • XY data formats
  • Append mode
• xml_parser — Tool XML Parser
  • Data classes
  • Functions
• simulator — Simulation Runner
  • run_simulation()
  • run_uq_simulation()
  • RunHistory
• app — FastAPI Web Application
  • Setup
  • REST API endpoints

Development

• Contributing
• Changelog