radical.radical.edge 0.2.0 documentation

This is …

Get involved or contact us:

Contents:

• 1. Module Documentation
  • 1.1. Overview
  • 1.2. Core Components
  • 1.3. Architecture
    • 1.3.1. Plugin Hierarchy
    • 1.3.2. Client Lifecycle
  • 1.4. Module API
    • 1.4.1. Main Module
    • 1.4.2. Edge Service
    • 1.4.3. Logging Configuration
• 2. Embedding the Edge Service
  • 2.1. Architecture
  • 2.2. Usage
    • 2.2.1. Synchronous Application (Threaded)
    • 2.2.2. Asyncio Application
  • 2.3. API Reference
    • EdgeService
  • 2.4. Configuration
  • 2.5. Notes
  • 2.6. Developing External Plugins
    • 2.6.1. Example: Weather Plugin
  • 2.7. Using PSIJ Plugin
    • 2.7.1. Prerequisites
    • 2.7.2. Usage
    • 2.7.3. API Endpoints
    • 2.7.4. Registering a Session
• 3. Plugin Development Guide
  • 3.1. Overview
  • 3.2. Architecture
    • 3.2.1. Base Classes
    • 3.2.2. Inheritance Hierarchy
  • 3.3. Creating a New Plugin
    • 3.3.1. Step 1: Define Your Session Class
    • 3.3.2. Step 2: Define Your Plugin Class
    • 3.3.3. Auto-Registered Routes
    • 3.3.4. Step 3: Define Your Client Class (Optional)
  • 3.4. Advanced Patterns
    • 3.4.1. Custom Session Creation
    • 3.4.2. Custom Session Registration
    • 3.4.3. Notifications
    • 3.4.4. Topology Updates
  • 3.5. UI Configuration
  • 3.6. JS Plugin Module API
    • 3.6.1. Required Exports
    • 3.6.2. Optional Exports
    • 3.6.3. The api Object
    • 3.6.4. Notifications
  • 3.7. Session Lifecycle
  • 3.8. Async / Sync Guidelines
  • 3.9. Testing Your Plugin
  • 3.10. Summary
• 4. Plugin API Reference
  • 4.1. Base Classes
    • 4.1.1. PluginClient
    • 4.1.2. ClientManagedPlugin
    • 4.1.3. Plugin
  • 4.2. Plugins
    • 4.2.1. PluginLucid
    • 4.2.2. PluginXGFabric
    • 4.2.3. PluginQueueInfo
    • 4.2.4. PluginSysInfo
    • 4.2.5. PluginPSIJ
    • 4.2.6. PluginRhapsody
  • 4.3. Queue Info Backend
    • 4.3.1. QueueInfo
• 5. REST API Reference
  • 5.1. Bridge Endpoints
    • 5.1.1. SSE Event Format
  • 5.2. Plugin Base Routes
  • 5.3. PsiJ Plugin
  • 5.4. Rhapsody Plugin
  • 5.5. Queue Info Plugin
  • 5.6. Sysinfo Plugin
  • 5.7. Staging Plugin
  • 5.8. XGFabric Plugin
  • 5.9. Error Responses

Indices and tables

• Index

• Module Index

• Search Page