Getting started#

PyAnsys Geometry is a Python client library for the Ansys Geometry service.

Installation#

You can use pip to install PyAnsys Geometry. If pip is new to you, you should read the Python Packaging User Guide Tutorial on pip <https://packaging.python.org/en/latest/tutorials/installing-packages/> before proceeding.

pip install ansys-geometry-core

Available modes#

This client library works with a Geometry service backend. There are several ways of running this backend, although the preferred and high-performance mode is using Docker containers. Select the option that suits your needs best.

Docker containers

Launch the Geometry service as a Docker container and connect to it from PyAnsys Geometry.

Docker containers
Local service

Launch the Geometry service locally on your machine and connect to it from PyAnsys Geometry.

Launch a local session
Remote service

Launch the Geometry service on a remote machine and connect to it using PIM (Product Instance Manager).

Launch a remote session
Connect to an existing service

Connect to an existing Geometry service locally or remotely.

Use an existing session

Compatibility with Ansys releases#

PyAnsys Geometry continues to evolve as the Ansys products move forward. For more information, see Ansys product version compatibility.

Development installation#

In case you want to support the development of PyAnsys Geometry, install the repository in development mode. For more information, see Install package in development mode.

Frequently asked questions#

Any questions? Refer to Q&A before submitting an issue.

Ansys developer ecosystem resources#

Ansys has an extensive developer ecosystem where you can find assistance for a variety of issues.

  • Developer Portal <https://developer.ansys.com/>: Blog posts, documentation, and guide - Developer Forum <https://discuss.ansys.com/>: Scripting and usage support for PyAnsys and other Ansys developer tools

  • Ansys Innovation Space <https://innovationspace.ansys.com/>: Product support forum and training materials

  • GitHub <https://github.com/ansys/pyansys-geometry>: Development support, bug reporting, feature requests, and more.

  • Ansys Learning Hub <https://learninghub.ansys.com/>: Training, courses and learning plans