An open API service indexing awesome lists of open source software.

https://github.com/ansys/ansys-engineeringworkflow-api

Common Python API for running and monitoring an Engineering Workflow
https://github.com/ansys/ansys-engineeringworkflow-api

api pyansys python python3 workflow

Last synced: about 1 month ago
JSON representation

Common Python API for running and monitoring an Engineering Workflow

Awesome Lists containing this project

README

        

Ansys Engineering Workflow API
==============================

Overview
--------
The Ansys Engineering Workflow API is a Python package that provides a
common interface for interacting with Ansys engineering workflow engines.

It is not a standalone package. It is intended to be used in conjunction with
other PyAnsys libraries.

Documentation and issues
------------------------

Documentation for the latest stable release of the Ansys Engineering Workflow API is hosted
at `Ansys Engineering Workflow API documentation `_.

The documentation has four sections:

- `Getting started `_: Learn
how to install the Ansys Engineering Workflow API.
- `User guide `_: Understand how to
use the Ansys Engineering Workflow API.
- `API reference `_: Understand Ansys Engineering Workflow
API endpoints, their capabilities, and how to interact with them programmatically.
- `Contribute `_: Learn how to
contribute to the Ansys Engineering Workflow API codebase or documentation.

In the upper right corner of the documentation's title bar, there is an option
for switching from viewing the documentation for the latest stable release
to viewing the documentation for the development version or previously
released versions.

On the `Ansys Engineering Workflow API Issues `_
page, you can create issues to report bugs and request new features. On the
`Ansys Engineering Workflow API Discussions `_
page or the `Discussions `_ page on the Ansys Developer portal,
you can post questions, share ideas, and get community feedback.

To reach the PyAnsys project support team, email `PyAnsys Core team `_.

License
-------

The Ansys Engineering Workflow API is licensed under the `MIT License `_.

The Ansys Engineering Workflow API makes no commercial claim over Ansys whatsoever.
This library is not intended for standalone use.