ansys-saf-product-configuration 0.23.dev1

Overview

SAF Product Configuration provides protocol-based interfaces and ready-to-use product definitions for launching products in SAF-based solutions.

Out of the box, the package contains the recipes, startup commands, environment settings, and version-specific metadata needed to launch selected Ansys products in a consistent way through SAF product instance systems such as HPS and PIM Light. These built-in configurations cover the following products, so solution developers can use proven launch definitions instead of reimplementing product startup behavior for each deployment.

From a business and solution-development perspective, SAF Product Configuration helps reduce the amount of custom code that developers need to write and maintain to launch products reliably. It provides an out-of-the-box connector layer for product startup and lifecycle integration, so teams can focus more on solution logic and user workflows instead of rebuilding product-specific launch, configuration, and instance-management behavior.

The package is not limited to the built-in Ansys product definitions. It also provides protocol-based interfaces for describing a product name, supported versions, execution command, environment variables, service type, and transport settings. This makes it possible for developers to create and load their own custom product configurations to start additional Ansys products or even third-party applications, while keeping the same SAF integration model and configuration workflow.

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 Product Configuration 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.

• API reference. The API reference section provides detailed documentation for the project’s application programming interface (API). It includes information about classes, functions, methods, and their parameters, return values, and usage examples. This reference helps developers understand the available API endpoints, their functionalities, and how to interact with them programmatically.

• Examples. The examples section showcases practical code examples that demonstrate how to use the project in real-world scenarios. It provides sample code snippets or complete scripts that illustrate different use cases or demonstrate specific features of the project. Examples serve as practical references for developers, helping them understand how to apply the project to their own applications.

• 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 Product Configuration 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.