Skip to content

ansys/pyworkbench-examples

Repository files navigation

PyWorkbench examples

PyAnsys GH-CI

About

PyWorkbench examples is a repository containing a plethora of showcases on how to use the PyWorkbench library. PyWorkbench is a Python library that provides a simple and intuitive way to create and manage simulation workflows over Ansys products.

Documentation

The official examples contains the following chapters:

  • Basic examples: A collection of basic examples that showcase the basic functionalities of PyWorkbench.
  • Advanced examples: A collection of advanced examples that showcase the more complex functionalities of PyWorkbench.

Additionally, you can build the documentation locally by following the steps:

  1. Install Tox in your local environment by running python -m pip install tox
  2. Build the documentation by running tox -e doc-html

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 PyWorkbench documentation for additional resources and troubleshooting guides.

License

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