PyAnsys Developer’s Guide#

The PyAnsys Developer’s Guide is the central document for:

  • Ansys developers who want to create and “own” PyAnsys libraries

  • Anyone in the Python community who wants to contribute to a PyAnsys library

  • Anyone who is interested in learning more about the PyAnsys project and PyAnsys libraries

This guide describes the PyAnsys project organization and administration. It also provides how-to information and summarizes packaging, coding, and documentation styles. It concludes with an abstractions section that explains how apps and complex services expose only functionalities that matter to users.

From the About area for the repository, you can click the link for the latest web-based release of this guide. In the Releases area, you can view information about all releases. In the Assets area for any release, you can download a PDF.

Getting started
What is PyAnsys?

An introduction to the PyAnsys project and its ecosystem.

Project approval and release

Steps to authorize the public release of a PyAnsys library.

Explanations
How-to

Detailed step-by-step guidelines.

Abstractions

Detailed explanations of the PyAnsys architecture.

Style guidelines
Packaging style

Best practices for distributing Python code.

Coding style

Best practices for writing Python code.

Documentation style

Best practices for writing documentation.