Style#

In the PyAnsys ecosystem, three key styles contribute to an enhanced developer experience: packaging style, coding style, and documentation style

  • Packaging style focuses on creating clear, open source APIs hosted on GitHub,allowing for reusable packages that can be updated independently of the Ansys release schedule.

  • Coding style adheres to PEP 8 and aligns with the conventions of major data science libraries like NumPy, SciPy, and pandas, ensuring consistency and readability.

  • Documentation style emphasizes the significance of well-documented APIs, offering increased adoption, an improved on-boarding experiences, and streamlined code maintenance. All PyAnsys libraries follow the Google developer documentation style guide, incorporating sentence case, active voice, and concise, clear sentences for cohesive and user-friendly documentation.

Packaging

Best practices for distributing Python code.

Coding

Best practices for writing Python code.

Documentation

Best practices for writing PyAnsys library documentation.