User guide#
Create a new solution by instantiating the solution template in your working directory.
Install the solution development environment using the saf install command.
Run your solution locally using saf run or Docker Compose deployment options.
Perform project management tasks like creating, sharing, upgrading, and deleting solution projects.
Explore techniques for debugging the backend, frontend, and telemetry issues in your solution.
Test your solution using fixtures for backend API testing, frontend Dash callbacks, and product instances.
Add a new step to an existing solution using the saf add-step command.
Package your solution as a distributable installer or archive for deployment.
Deploy solutions on desktop or on-premises infrastructure via Windows services, Docker Compose, or K3s.
Define your workflow, steps, transaction methods, and manage files and folders.
Build the user interface using the Dash framework and client-side interaction patterns.
Configure the SAF runtime using environment variables for SAF GLOW Engine, SAF, OTel, and other components.
Learn about the servers in your solution stack and the roles they play in local development.
Use a Python script to control a SAF-based application and explore available APIs and configurations.
Review Ansys product and third-party tool integrations with version compatibility details.
Explore the SAF components, their roles, relationships, and installation via the
ansys-saf-sdk meta-package.
Follow recommended patterns and guidelines for building robust, maintainable SAF solutions.
Access migration instructions for upgrading SAF solutions across major versions.
Diagnose and resolve installation, dependency, deployment, backend, and network issues.