ansys-saf-product-manager 0.5.0

Overview

The ansys-saf-product-manager package provides ready-to-use managers for launching and controlling Ansys product instances within SAF-based solutions. Each manager wraps the corresponding PyAnsys client library and exposes a consistent API for initializing, connecting to, and interacting with the product.

Within the SAF ecosystem, the Product Manager layer sits between solution code and the underlying PyAnsys clients. It handles the details of product startup, connection management, and lifecycle control so that solution developers can work with Ansys products through a uniform interface without writing low-level initialization logic themselves.

The package currently supports the following products:

Each product manager is packaged as an optional extra, so solutions only pull in the dependencies they actually need.

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 Manager 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, 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.

Using GitHub Copilot for Development

This repository includes a Copilot instructions file that provides AI-assisted development guidance. When working on SAF Product Manager enhancements or bug fixes:

1. GitHub Copilot will automatically reference the project structure, architecture, and development guidelines from the instructions file.

2. The instructions cover core concepts like product manager patterns, optional dependency handling, and code style expectations.

3. Use Copilot to generate code that follows the established patterns for product managers, PyAnsys client integration, and shared utilities.

4. The instructions emphasize type hints, the fully typed codebase, and the modular structure with one subdirectory per supported product.

This helps ensure consistency across contributions and speeds up development workflows.

Suggested Copilot Prompt:

When starting a new feature or fix, you can use a prompt like this to guide Copilot:

“I’m working on the SAF Product Manager project. [Describe your task]. Please follow the project’s Copilot instructions, including type hints, the existing modular structure in src/ansys/saf/product_manager/, and the pattern of one subdirectory per supported product. Ensure the code integrates with the existing modules and includes appropriate error handling.”

This prompt helps ensure Copilot generates code that aligns with SAF Product Manager’s architecture and standards.

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 Manager 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, please 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.