API reference#

The pyansys metapackage on its own does not have a specific API. The only information specific-only to this package that can be provided is its version. This can be looked up as follows:

>>> from pyansys import __version__
>>> __version__

'2023.1.0'

However, each of the PyAnsys packages that shape the pyansys metapackage have their own specific API reference section. In order to navigate through them, please refer to their documentation.

PyAnsys packages API reference#

PyACP

https://acp.docs.pyansys.com/version/dev/api/index.html

PyAdditive

https://additive.docs.pyansys.com/version/0.18/api/index.html

PyAdditive Widgets

https://widgets.additive.docs.pyansys.com/version/0.2/api/index.html

PyAEDT

https://aedt.docs.pyansys.com/version/0.9/API/index.html

PyAnsys Geometry

https://geometry.docs.pyansys.com/version/0.6/api/index.html

PyAnsys Math

https://math.docs.pyansys.com/version/0.1/api/index.html

PyAnsys Sound

https://sound.docs.pyansys.com/version/0.1/api/index.html

PyConceptEV

https://conceptev.docs.pyansys.com/version/0.1/api_ref.html

PyDPF - Core

https://dpf.docs.pyansys.com/version/0.12/api/index.html

PyDPF - Post

https://post.docs.pyansys.com/version/0.8/api/index.html

PyDPF - Composites

https://composites.dpf.docs.pyansys.com/version/0.5/api/index.html

PyDyna

https://dyna.docs.pyansys.com/version/0.4/autoapi/index.html

PyDynamicReporting

https://dynamicreporting.docs.pyansys.com/version/0.6/class_documentation.html

PyEDB

https://edb.docs.pyansys.com/version/0.23/api/index.html

PyEDB - Core

https://edb.core.docs.pyansys.com/version/0.1/api/index.html

PyEnSight

https://ensight.docs.pyansys.com/version/0.8/class_documentation.html

PyFluent

https://fluent.docs.pyansys.com/version/0.22/api/index.html

PyFluent - Visualization

https://visualization.fluent.docs.pyansys.com/version/0.11/api/index.html

PyGranta

https://grantami.docs.pyansys.com/version/2024.2/api.html

PyHPS

https://hps.docs.pyansys.com/version/0.8/api/index.html

PyMAPDL

https://mapdl.docs.pyansys.com/version/0.68/api/index.html

PyMAPDL Reader

https://reader.docs.pyansys.com/version/0.53/api/index.html

PyMechanical

https://mechanical.docs.pyansys.com/version/0.11/api/index.html

PyModelCenter

https://modelcenter.docs.pyansys.com/version/0.1/api/index.html

PyMotorCAD

https://motorcad.docs.pyansys.com/version/0.5/methods/index.html

PyOptislang

https://optislang.docs.pyansys.com/version/0.8/api/index.html

PyPIM

https://pypim.docs.pyansys.com/version/1.1/api/index.html

PyPrimeMesh

https://prime.docs.pyansys.com/version/0.6/api/index.html

PyRocky

https://rocky.docs.pyansys.com/version/0.2/api/index.html

PySeascape

https://seascape.docs.pyansys.com/version/0.2/#usage

PySherlock

https://sherlock.docs.pyansys.com/version/0.6/api/index.html

PySimAI

https://simai.docs.pyansys.com/version/0.2/api_reference.html

PySystemCoupling

https://systemcoupling.docs.pyansys.com/version/0.6/api/index.html

PyTurboGrid

https://turbogrid.docs.pyansys.com/version/0.4/api_reference/index.html

PyTwin

https://twin.docs.pyansys.com/version/0.7/api/index.html

PyWorkbench

https://workbench.docs.pyansys.com/version/0.6/api/index.html

Shared Components - OpenAPI Common

https://openapi.docs.pyansys.com/version/stable/api/index.html