Getting started#

The PyAnsys project exposes Ansys technologies via libraries in the Python ecosystem. Each library provides clear, concise, and maintainable APIs. Useful Pythonic functions, classes, and plugins allow users to interact with targeted products and services in a high-level, object-orientated approach.

The PyAnsys ecosystem refines the component-level interaction with Ansys solvers and tools, and eliminates the inconsistent and restrictive scripting environments found within product installations.

These component libraries play a vital role in:

  • Application automation

  • Machine learning

  • Postprocessing

  • Data visualization

  • Workflow orchestration

  • Data manipulation and export

The libraries also include plugins and interfaces to packages in the vast Python ecosystem. Examples include:

Note

If you are new to GitHub, you should visit The ReadMe Project. It is a dedicated platform for highlighting the best from the open source software community. Each monthly newsletter provides links to feature articles, developer stories, guides, and podcasts.

Contributing to this guide#

If you would like to contribute to this development guide, maintainers gladly review all pull requests. Please follow the Documentation style.

This repository uses the pre-commit library to automate style checking. To use it, enter your Python environment and install it with:

pip install pre-commit

You can then run it manually with:

pre-commit run --all-files

This performs various style and spelling checks to ensure your contributions meet minimum coding style and documentation standards.

You can make sure that these checks are always run prior to git commit by installing a pre-commit as a git hook with:

pre-commit install

Now, each time you run git commit, your commit is only created if it passes the minimum style checks that also run on the GitHub CI/CD.