Serverless ADR

Serverless ADR is a lightweight, local Python API for building reports using Ansys Dynamic Reporting (ADR), without requiring a running ADR service or network connection.

It operates entirely within your Python process, directly writing to and reading from a local ADR-compatible database (e.g., SQLite or PostgreSQL). This allows you to generate and render full ADR reports, create items and templates, and manage media and static assets — all without launching the ADR backend server.

It is built on the same core schema as the traditional service-based ADR, but works entirely within your local Python environment.

This system is designed for cases where developers or simulation engineers want to:

• Create, manage, and render reports locally using Python

• Avoid setting up a centralized ADR service or HTTP connection

• Maintain full fidelity with the ADR schema (items, templates, etc.)

• Output HTML content and media assets for web and desktop apps.

Serverless ADR is ideal for:

• Local, file-based workflows (e.g., building offline reports)

• Embedding reports in web or desktop applications

• Use in batch scripts, Python notebooks, or simulations

Key features

• Drop-in compatibility with Ansys installations and the Service API: Uses the same Python environment and static/media assets from your installed ADR system.

• Flexible instantiation: Supports SQLite and PostgreSQL databases, Docker-based environments, in-memory and legacy environment-variable configurations.

• In-memory execution: Runs entirely in your local Python process, with no separate backend or daemon needed.

• First-class objects: Sessions, Datasets, Items and Templates are actual Python classes, not remote proxies — giving you full introspection, subclassing, and lifecycle control.

• Comprehensive rendering: Generates full HTML reports — just like the service-based API — with full support for media, static assets, and custom layouts.

Explore the docs

Contents:

• Quickstart
  • Instantiation and Setup
  • Creating Items
  • Building Templates
  • Rendering the Report
  • Accessing the ADR Instance
• Overview
  • Key Benefits
  • Core Concepts
  • Built on Django ORM
  • Use Cases
• Instantiation
  • Single SQLite Database (Recommended)
  • Multiple Databases
  • In-Memory Mode
  • Docker-Based Instantiation
  • Legacy Environment Variable Configuration
  • Important Notes
• Sessions and Datasets
  • Conceptual Overview
  • Key Entities
  • Session and Dataset Properties and Metadata
  • Creating Sessions and Datasets
  • Setting Defaults in ADR
  • Accessing Current Session and Dataset
  • Fetching Existing Sessions and Datasets
  • Using Sessions and Datasets When Creating Items
  • Lifecycle Notes
  • Exceptions and Validation
  • Summary
• Items
  • Core Concepts
  • Creating Items
  • Item Properties and Metadata
  • Working With File-Based Items
  • Rendering Items
  • Querying Items
  • Lifecycle Notes
  • Exceptions and Validation
  • Summary
• Templates
  • Overview
  • Creating Templates
  • Template Types
  • Template Attributes and Methods
  • Template Parameters
  • Template Properties
  • Filters
  • Sorting
  • Working with Template Hierarchies
  • Example: Creating a Nested Template Structure
  • Rendering Templates
  • Lifecycle Notes
  • Exceptions and Validation
  • Summary
• Querying
  • Query Methods
  • Examples
  • Subclass Queries
  • Understanding ADR Query Strings
  • Querying Sessions and Datasets
  • Working with Query Results
  • Error Handling
  • Summary
  • Next Steps
• Media and Static Files
  • Overview
  • Configuration
  • File Storage and Access
  • Managing Media Files in Items
  • Working with Media Files Directly
  • Static Files Collection and Serving
  • In-Memory Mode and Temporary Files
  • Best Practices
  • Troubleshooting
  • Summary
  • Next Steps
• Embedding Reports
  • Overview
  • Generating Embed-Ready HTML
  • Embedding Individual Items
  • Embedding Partial Templates or Sections
  • Integration Tips
  • Serving Embedded Content
  • Security Considerations
  • Summary
  • Next Steps
• Copying Objects
  • Prerequisites
  • API Usage
  • Parameters
  • Copying Logic Details
  • Error Handling
  • Implementation Notes
  • Best Practices
  • Summary
  • Next Steps
• Deleting Objects
  • Deletion Methods
  • Example Usage Patterns
  • Important Notes and Caveats
  • Error Handling
  • Best Practices
• Configuration
  • Overview
  • Key Configuration Parameters
• Environment Variables
  • Core Variables
  • Database Connection Variables
  • Security Variables
  • Advanced / Optional Variables
  • Usage Notes
  • Best Practices
  • Examples
  • Troubleshooting
  • Summary
• Examples
• Caveats
  • Multiprocessing / Multithreading Usage
  • Process-Level Initialization
  • Thread-Level Behavior
  • Serverless ADR Usage Within Django Apps
  • Summary and Best Practices