Contents

• Overview
  • Installation
  • Basic usage
  • Documentation and issues

Overview

PyAnsys Geometry is a Python client library for the Ansys Geometry service, as well as other CAD Ansys products such as Ansys Discovery and Ansys SpaceClaim.

Installation

You can use pip to install PyAnsys Geometry.

pip install ansys-geometry-core

Or, using uv:

uv add ansys-geometry-core

For optional graphics support (PyVista, VTK, pygltflib), install the graphics extra. To include all optional dependencies, use the all extra instead:

pip install "ansys-geometry-core[graphics]"
pip install "ansys-geometry-core[all]"

uv add "ansys-geometry-core[graphics]"
uv add "ansys-geometry-core[all]"

You can also install PyAnsys Geometry from Conda-Forge:

conda install -c conda-forge ansys-geometry-core

To install the latest development version, run these commands:

Using pip:

git clone https://github.com/ansys/pyansys-geometry
cd pyansys-geometry
pip install -e .

Using uv:

git clone https://github.com/ansys/pyansys-geometry
cd pyansys-geometry
uv sync

For more information, see Getting Started.

Basic usage

This code shows how to import PyAnsys Geometry and use some basic capabilities:

from ansys.geometry.core import launch_modeler
from ansys.geometry.core.math import Plane, Point3D, Point2D
from ansys.geometry.core.misc import UNITS, Distance
from ansys.geometry.core.sketch import Sketch

# Define a sketch
origin = Point3D([0, 0, 10])
plane = Plane(origin, direction_x=[1, 0, 0], direction_y=[0, 1, 0])

# Create a sketch
sketch = Sketch(plane)
sketch.circle(Point2D([1, 1]), 30 * UNITS.m)
sketch.plot()

# Start a modeler session
modeler = launch_modeler()

# Create a design
design = modeler.create_design("ModelingDemo")

# Create a body directly on the design by extruding the sketch
body = design.extrude_sketch(
    name="CylinderBody", sketch=sketch, distance=Distance(80, unit=UNITS.m)
)

# Plot the body
design.plot()

# Export the model to SCDOCX format
file_path = design.export_to_scdocx()

For comprehensive usage information, see Examples in the PyAnsys Geometry documentation.

Documentation and issues

Documentation for the latest stable release of PyAnsys Geometry is hosted at PyAnsys Geometry documentation.

In the upper right corner of the documentation's title bar, there is an option for switching from viewing the documentation for the latest stable release to viewing the documentation for the development version or previously released versions.

On the PyAnsys Geometry Issues page, you can create issues to report bugs and request new features. On the PyAnsys Geometry Discussions page or the Discussions page on the Ansys Developer portal, you can post questions, share ideas, and get community feedback.

To reach the project support team, email pyansys.core@ansys.com.