Solution Application Framework - SDK

Overview

ansys-saf-sdk is a meta-package that bundles the core SAF packages into a single, versioned package. It has no code of its own — it only declares dependencies on the individual SAF packages, pinned to their latest compatible versions.

Installation

Ensure you have all the necessary prerequisites.

Note: Installing ansys-saf-sdk requires pip 26.0 or higher.

To install the SAF SDK, run:

pip install ansys-saf-sdk

Core dependencies

Installing ansys-saf-sdk installs these packages by default:

• ansys-bdm-api
• ansys-bdm-shared-volume
• ansys-saf-glow-engine
• ansys-iam-oidc
• ansys-saf-product-configuration
• ansys-saf-product-manager

Extras

Optional extras pull in additional packages, or extras of the core packages, for specific scenarios:

For example, to install the SAF SDK with Dash and PIM support:

pip install "ansys-saf-sdk[core-dash,core-pim]"

Documentation

Visit the official documentation for detailed information on how to use the SAF SDK.

Troubleshooting

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

Please 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.

Contribute

Contributions are welcome! If you would like to contribute, please follow the guidelines provided in the Contribute section of the official documentation.

License

You can find the full text of the license in the LICENSE file.

Changelog

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

This package has no code of its own, so it has no changelog file. Each bundled package maintains its own CHANGELOG.md in the packages directory of the project repository.