Skip to main content
Yanked

This release has been yanked by its maintainers, and will be ignored by installers, except when explicitly specified.
Consider using release 2026.1.3 instead.

https://travis-ci.org/akaszynski/pyansys.svg?branch=master http://readthedocs.org/projects/pyansys/badge/?version=latest
This Python module allows you to:
  • Interactively control an instance of ANSYS v17.0 + using Python.

  • Extract data directly from binary ANSYS v14.5+ files and to display or animate them.

  • Rapidly read in binary result (.rst), binary mass and stiffness (.full), and ASCII block archive (.cdb) files.

See the Documentation page for more details.

Installation

Installation through pip:

pip install pyansys

You can also visit GitHub to download the source.

Quick Examples

Many of the following examples are built in and can be run from the build-in examples module. For a quick demo, run:

from pyansys import examples
examples.RunAll()

Controlling ANSYS

Create an instance of ANSYS and interactively send commands to it. This is a direct interface and does not rely on writing a temporary script file. You can also generate plots using matplotlib.

import os
import pyansys

path = os.getcwd()
ansys = pyansys.ANSYS(run_location=path, interactive_plotting=True)

# create a square area using keypoints
ansys.Prep7()
ansys.K(1, 0, 0, 0)
ansys.K(2, 1, 0, 0)
ansys.K(3, 1, 1, 0)
ansys.K(4, 0, 1, 0)
ansys.L(1, 2)
ansys.L(2, 3)
ansys.L(3, 4)
ansys.L(4, 1)
ansys.Al(1, 2, 3, 4)
ansys.Aplot()
ansys.Save()
ansys.Exit()
https://github.com/akaszynski/pyansys/raw/master/doc/images/aplot.png

Loading and Plotting an ANSYS Archive File

ANSYS archive files containing solid elements (both legacy and current), can be loaded using ReadArchive and then converted to a vtk object.

import pyansys
from pyansys import examples

# Sample *.cdb
filename = examples.hexarchivefile

# Read ansys archive file
archive = pyansys.ReadArchive(filename)

# Print raw data from cdb
for key in archive.raw:
   print("%s : %s" % (key, archive.raw[key]))

# Create a vtk unstructured grid from the raw data and plot it
grid = archive.ParseVTK()
grid.Plot()

# write this as a vtk xml file
grid.Write('hex.vtu')
https://github.com/akaszynski/pyansys/raw/master/doc/images/hexbeam.png

You can then load this vtk file using vtkInterface or another program that uses VTK.

# Load this from vtk
import vtkInterface
grid = vtkInterface.UnstructuredGrid('hex.vtu')
grid.Plot()

Loading and Plotting an ANSYS Result File

This example reads in binary results from a modal analysis of a beam from ANSYS.

# Load the reader from pyansys
import pyansys

# Sample result file
from pyansys import examples
rstfile = examples.rstfile

# Create result reader object by loading the result file
result = pyansys.ResultReader(rstfile)

# Get the solution time values (natural frequencies for this modal analysis)
freqs = result.GetTimeValues()

# Get the node numbers in this result file
nnum = result.nnum

# Get the 1st bending mode shape.  Nodes are ordered according to nnum.
disp = result.GetNodalResult(0, True) # uses 0 based indexing

# it's just a numpy array
print(disp)
[[  0.           0.           0.        ]
 [  0.           0.           0.        ]
 [  0.           0.           0.        ]
 ...,
 [ 21.75315943 -14.01733637  -2.34010126]
 [ 26.60384371 -17.14955041  -2.40527841]
 [ 31.50985156 -20.31588852  -2.4327859 ]]

You can plot results as well directly from the file as well.

# Plot the displacement of the 1st in the x direction
result.PlotNodalResult(0, 'x', label='Displacement')

# Plot the nodal stress in the 'x' direction for the 6th result
result.PlotNodalStress(5, 'Sx')
https://github.com/akaszynski/pyansys/raw/master/doc/images/beam_stress.png

Reading a Full File

This example reads in the mass and stiffness matrices associated with the above example.

# Load the reader from pyansys
import pyansys
from scipy import sparse

# load the full file
fobj = pyansys.FullReader('file.full')
dofref, k, m = fobj.LoadKM()  # returns upper triangle only

# make k, m full, symmetric matricies
k += sparse.triu(k, 1).T
m += sparse.triu(m, 1).T

If you have scipy installed, you can solve the eigensystem for its natural frequencies and mode shapes.

from scipy.sparse import linalg

# condition the k matrix
# to avoid getting the "Factor is exactly singular" error
k += sparse.diags(np.random.random(k.shape[0])/1E20, shape=k.shape)

# Solve
w, v = linalg.eigsh(k, k=20, M=m, sigma=10000)
# System natural frequencies
f = (np.real(w))**0.5/(2*np.pi)

print('First four natural frequencies')
for i in range(4):
    print '{:.3f} Hz'.format(f[i])
First four natural frequencies
1283.200 Hz
1283.200 Hz
5781.975 Hz
6919.399 Hz

License and Acknowledgments

pyansys is licensed under the MIT license.

ANSYS documentation and functions build from html provided by Sharcnet. Thanks!

This module, pyansys makes no commercial claim over ANSYS whatsoever. This tool extends the functionality of ANSYS by adding a python interface in both file interface as well as interactive scripting without changing the core behavior or license of the original software. The use of the interactive APDL control of pyansys requires a legally licensed local copy of ANSYS.

Metadata

Release files for pyansys 0.32.0

For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.

Source distribution (sdist)

Source distribution for pyansys 0.32.0
File Size Uploaded
pyansys-0.32.0.tar.gz 1.4 MB Details

Built distributions (wheels)

Table of built distributions (wheels) for pyansys 0.32.0
File
pyansys-0.32.0-cp36-cp36m-win_amd64.whl CPython 3.6 CPython 3.6 pymalloc Windows x86-64 Details
pyansys-0.32.0-cp36-cp36m-manylinux1_x86_64.whl CPython 3.6 CPython 3.6 pymalloc Linux glibc 2.5+ x86-64 Details
pyansys-0.32.0-cp35-cp35m-win_amd64.whl CPython 3.5 CPython 3.5 pymalloc Windows x86-64 Details
pyansys-0.32.0-cp35-cp35m-manylinux1_x86_64.whl CPython 3.5 CPython 3.5 pymalloc Linux glibc 2.5+ x86-64 Details
pyansys-0.32.0-cp27-cp27mu-manylinux1_x86_64.whl CPython 2.7 CPython 2.7 pymalloc wide-unicode Linux glibc 2.5+ x86-64 Details
pyansys-0.32.0-cp27-cp27m-manylinux1_x86_64.whl CPython 2.7 CPython 2.7 pymalloc Linux glibc 2.5+ x86-64 Details

Total release size: 21.8 MB

Release files / pyansys-0.32.0.tar.gz

Download URL pyansys-0.32.0.tar.gz
Size 1.4 MB
Tags Source
SHA-256 checksum
How to use checksums
aa266c0fde31ed538b3bbe557b5854eedbd83205c956032bcbdfc592f8c594a8
BLAKE2b-256 checksum
How to use checksums
ab9bebbe42cc271a75bbd7acab9d78f84812a34f7493be747d137eb6f87e1b63
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via twine/1.11.0 pkginfo/1.4.2 requests/2.19.1 setuptools/38.2.4 requests-toolbelt/0.8.0 tqdm/4.25.0 CPython/3.6.3

Release files / pyansys-0.32.0-cp36-cp36m-win_amd64.whl

Download URL pyansys-0.32.0-cp36-cp36m-win_amd64.whl
Size 2.0 MB
Tags CPython 3.6 CPython 3.6 pymalloc Windows x86-64
SHA-256 checksum
How to use checksums
ba97e90155c29445ecc030497bc701d0fae1db30b581208d16baf1535b5e3894
BLAKE2b-256 checksum
How to use checksums
6e3bb3b0b23a6cec3ed558f6f302427209434c3019be58c0ba0f242c803ea734
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via twine/1.11.0 pkginfo/1.4.2 requests/2.18.4 setuptools/39.0.1 requests-toolbelt/0.8.0 tqdm/4.23.1 CPython/3.6.5

Release files / pyansys-0.32.0-cp36-cp36m-manylinux1_x86_64.whl

Download URL pyansys-0.32.0-cp36-cp36m-manylinux1_x86_64.whl
Size 4.2 MB
Tags CPython 3.6 CPython 3.6 pymalloc Linux glibc 2.5+ x86-64
SHA-256 checksum
How to use checksums
10ae1edba15f594fbfb35097ddeadd6b309a241f0eb739d478fb9064ffcaff45
BLAKE2b-256 checksum
How to use checksums
7bcd235b5b62dd74527242e0cd8e8b3ae0a0564217ff9f8787cfdc2de136ae79
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via twine/1.11.0 pkginfo/1.4.2 requests/2.19.1 setuptools/38.2.4 requests-toolbelt/0.8.0 tqdm/4.25.0 CPython/3.6.3

Release files / pyansys-0.32.0-cp35-cp35m-win_amd64.whl

Download URL pyansys-0.32.0-cp35-cp35m-win_amd64.whl
Size 2.0 MB
Tags CPython 3.5 CPython 3.5 pymalloc Windows x86-64
SHA-256 checksum
How to use checksums
fbf6b8f2245559c9fff847c39448b039da534f3afd25847d893ef9165acb34c9
BLAKE2b-256 checksum
How to use checksums
a503af817432bd39914facdbaae00d51a552d06d1d1d6b6645596e5b7d4780b1
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via twine/1.11.0 pkginfo/1.4.2 requests/2.18.4 setuptools/39.0.1 requests-toolbelt/0.8.0 tqdm/4.23.1 CPython/3.6.5

Release files / pyansys-0.32.0-cp35-cp35m-manylinux1_x86_64.whl

Download URL pyansys-0.32.0-cp35-cp35m-manylinux1_x86_64.whl
Size 4.1 MB
Tags CPython 3.5 CPython 3.5 pymalloc Linux glibc 2.5+ x86-64
SHA-256 checksum
How to use checksums
da23da572180e8550bddc0eba1c57f7ebade661fa80702c08604a9966f536615
BLAKE2b-256 checksum
How to use checksums
6df015250a0d1e2afce581cd432fb5031a335df6e39a4f9f35375bd0572fb65f
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via twine/1.11.0 pkginfo/1.4.2 requests/2.19.1 setuptools/38.2.4 requests-toolbelt/0.8.0 tqdm/4.25.0 CPython/3.6.3

Release files / pyansys-0.32.0-cp27-cp27mu-manylinux1_x86_64.whl

Download URL pyansys-0.32.0-cp27-cp27mu-manylinux1_x86_64.whl
Size 4.1 MB
Tags CPython 2.7 CPython 2.7 pymalloc wide-unicode Linux glibc 2.5+ x86-64
SHA-256 checksum
How to use checksums
438dbd373e53d5c026853fd0fcb7e5656cee61ea669cc5b422e71699b9966bba
BLAKE2b-256 checksum
How to use checksums
5558f7a692b97f7f488d309bce5e4306d08f2c166ef8b77e55013a9b52f1ccbb
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via twine/1.11.0 pkginfo/1.4.2 requests/2.19.1 setuptools/38.2.4 requests-toolbelt/0.8.0 tqdm/4.25.0 CPython/3.6.3

Release files / pyansys-0.32.0-cp27-cp27m-manylinux1_x86_64.whl

Download URL pyansys-0.32.0-cp27-cp27m-manylinux1_x86_64.whl
Size 4.1 MB
Tags CPython 2.7 CPython 2.7 pymalloc Linux glibc 2.5+ x86-64
SHA-256 checksum
How to use checksums
c41e2c04e9ccd8e85ce010670026ecd82a378b078639cc0f4f1344393943f441
BLAKE2b-256 checksum
How to use checksums
4df93c5f7d8852ff72e7cb2c15a4bd5123c697a04aac90846d266f21c2d33d59
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via twine/1.11.0 pkginfo/1.4.2 requests/2.19.1 setuptools/38.2.4 requests-toolbelt/0.8.0 tqdm/4.25.0 CPython/3.6.3

Release history Release notifications | RSS feed

This release

0.32.0 This release

7 release files

Anthropic, PBC Visionary sponsor Bloomberg Visionary sponsor Hudson River Trading Visionary sponsor Meta Visionary sponsor NVIDIA Visionary sponsor Microsoft Sustainability sponsor Depot Continuous Integration AWS Cloud computing and Security Sponsor Datadog Monitoring Fastly CDN Google Download Analytics Sentry Error logging StatusPage Status page