Overview

The SAF Desktop Installer enables packaging SAF-based solutions into standalone, distributable installers for desktop deployment. It is part of the Solution Application Framework (SAF) toolchain and is typically invoked through the saf build command provided by the SAF CLI.

The generated installer is self-contained: it bundles the solution code, all Python dependencies, and the Python interpreter itself, so end users can run the solution without needing a pre-configured development environment. Ansys products and other external tools required by the solution must still be installed separately on the target machine.

Key capabilities include:

• Standalone packaging: Uses PyInstaller to produce a single installer that includes all necessary dependencies and a Python interpreter.

• Cross-platform support: Generates installers compatible with the operating system where the build is executed (Windows .exe or Linux executable).

• Online and offline modes: By default, installers download dependencies at install time; the --offline-package option bundles everything for environments without internet access.

• Customizable build options: Supports encryption, code obfuscation, custom entry points, and configurable Python versions.

• Documentation embedding: Automatically builds and embeds Sphinx documentation so users can access it offline from within the solution.

From a workflow perspective, the Desktop Installer is the final step in preparing a solution for distribution. Once a solution has been developed and tested locally using the SAF CLI and Desktop Orchestrator, the installer packages it into a form that can be delivered to end users or deployed across an organization.

Installation

Ensure you have all the necessary prerequisites. Then, refer to the installation guidelines for detailed instructions on how to install the project in your system.

Documentation

The official documentation of SAF Desktop Installer contains the following chapters:

• Getting started. This section provides a brief overview and instructions on how to get started with the project. It typically includes information on how to install the project, set up any necessary dependencies, and run a basic example or test to ensure everything is functioning correctly.

• User guide. The user guide section offers detailed documentation and instructions on how to use the project. It provides comprehensive explanations of the project’s features, functionalities, and configuration options. The user guide aims to help users understand the project’s concepts, best practices, and recommended workflows.

• Contribute. This section provides guidelines and instructions on how to contribute to the project. It includes information on how to set up the development environment, run tests, submit pull requests, and follow contribution guidelines.

Troubleshooting

For troubleshooting or reporting issues, open an issue in the project repository.

Follow these steps to report an issue:

• Go to the project repository.

• Click on the Issues tab.

• Click on the New Issue button.

• Provide a clear and detailed description of the issue you are facing.

• Include any relevant error messages, code snippets, or screenshots.

Additionally, you can refer to the official documentation for additional resources and troubleshooting guides.

License

This project is licensed under the Apache 2.0 License - see the LICENSE file for details.

Changelog

The changelog section provides a summary of notable changes for each version of SAF Desktop Installer for Python. It helps you keep track of updates, bug fixes, new features, and improvements made to the project over time.

To view the complete changelog, visit the project repository and navigate to the CHANGELOG file. It provides a comprehensive list of changes categorized by version, along with brief descriptions of each change.