Skip to main content

Solution Application Framework - SDK

Python PyPI GH-CI Certified Apache Ruff

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:

Extra Description
core-dash GLOW engine support for Dash-based frontends.
core-pim GLOW engine support for Product Instance Management (PIM).
core-hps GLOW engine support for HPC Platform Services (HPS).
core-test GLOW engine testing utilities.
core-mcp GLOW engine support for the Model Context Protocol (MCP).
core-all All optional extras of the core packages.
instance-management Product configuration and product manager packages.
instance-management-fluent Instance management support for Ansys Fluent.
instance-management-aedt Instance management support for Ansys Electronics Desktop (AEDT).
instance-management-optislang Instance management support for optiSLang.
instance-management-geometry Instance management support for Ansys Geometry.
instance-management-mapdl Instance management support for Ansys MAPDL.
instance-management-mechanical Instance management support for Ansys Mechanical.
instance-management-visor Instance management support for Visor-based products.
instance-management-all All instance management product integrations.
desktop Desktop orchestrator and Projects dashboard for running solution applications as desktop apps.
build Desktop installer, for building standalone desktop installers.
all Every optional extra combined.

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.

Metadata

Release files for ansys-saf-sdk 0.5.0

For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.

Source distribution (sdist)

Source distribution for ansys-saf-sdk 0.5.0
File Size Uploaded Provenance
ansys_saf_sdk-0.5.0.tar.gz 8.2 kB With provenance Details

Built distribution (wheel)

Table of built distributions (wheels) for ansys-saf-sdk 0.5.0
File Interpreter ABI Platform
ansys_saf_sdk-0.5.0-py3-none-any.whl Python 3 none any Details

Total release size: 16.0 kB

Release files / ansys_saf_sdk-0.5.0.tar.gz

Download URL ansys_saf_sdk-0.5.0.tar.gz
Size 8.2 kB
Tags Source
SHA-256 checksum
How to use checksums
1845dda7f64f8167d9d3b84a3370ddcf54b5c8cdc0f14756db24de098bdc7921
BLAKE2b-256 checksum
How to use checksums
42354590eaea1f9436e8a3cf612c5d9bd32735ec1b8753b7b2e016c2c17dbdb9
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
Yes
Uploaded via twine/7.0.0 CPython/3.13.14

Provenance

Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.

PyPI Publish Attestation

PyPI verified that this artifact, at this checksum, originated from the publisher listed below.

Signed by GitHub Actions, verified by PyPI on Oct 22, 2026.

Transparency log

Release files / ansys_saf_sdk-0.5.0-py3-none-any.whl

Download URL ansys_saf_sdk-0.5.0-py3-none-any.whl
Size 7.8 kB
Tags Python 3
SHA-256 checksum
How to use checksums
acce6e37a8027440c3045302fa7dbc7689bef73dd0afa7cb90dce1c3c7c5ab66
BLAKE2b-256 checksum
How to use checksums
908f5fa6e46482d585a39e198ee6d60faaa5a67114102742d1343f6830001bbf
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
Yes
Uploaded via twine/7.0.0 CPython/3.13.14

Provenance

Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.

PyPI Publish Attestation

PyPI verified that this artifact, at this checksum, originated from the publisher listed below.

Signed by GitHub Actions, verified by PyPI on Oct 22, 2026.

Transparency log

Security for ansys-saf-sdk 0.5.0

Provenance

Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.

Full provenance

All 2 files in this release have been uploaded with provenance metadata.

Select from 2 files

Attestation for ansys_saf_sdk-0.5.0.tar.gz

PyPI Publish Attestation

PyPI verified that this artifact, at this checksum, originated from the publisher listed below.

Signed by GitHub Actions, verified by PyPI on Oct 22, 2026.

Transparency log

A note on package security

PyPI is a repository for distributing packages, not a service for auditing them. While third-party security researchers and our staff do their best to detect and remove malicious packages, PyPI cannot guarantee the quality, security or suitability of any given package.

To learn more about protecting yourself from malicious actors, visit our package security documentation.

Anthropic, PBC Visionary sponsor Bloomberg Visionary sponsor Hudson River Trading Visionary sponsor Meta Visionary sponsor NVIDIA Visionary sponsor Microsoft Sustainability sponsor Depot Continuous Integration AWS Cloud computing and Security Sponsor Datadog Monitoring Fastly CDN Google Download Analytics Sentry Error logging StatusPage Status page