Skip to main content

Pythonic interface to ANSYS binary files

Project description

https://img.shields.io/pypi/v/pyansys.svg https://dev.azure.com/femorph/pyansys/_apis/build/status/akaszynski.pyansys?branchName=master
This Python module allows you to:
  • Interactively control an instance of ANSYS v14.5 + using Python on Linux, >=17.0 on Windows.

  • 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.run_all()

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.Mapdl(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/docs/images/aplot.png

Loading and Plotting an ANSYS Archive File

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

import pyansys
from pyansys import examples

# Sample *.cdb
filename = examples.hexarchivefile

# Read ansys archive file
archive = pyansys.Archive(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.parse_vtk(force_linear=True)
grid.plot(color='w', show_edges=True)

# write this as a vtk xml file
grid.save('hex.vtu')

# or as a vtk binary
grid.save('hex.vtk')
https://github.com/akaszynski/pyansys/raw/master/docs/images/hexbeam.png

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

# Load this from vtk
import pyvista as pv
grid = pv.UnstructuredGrid('hex.vtu')
grid.plot()

Loading the Result File

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

# Load the reader from pyansys
import pyansys
from pyansys import examples

# Sample result file
rstfile = examples.rstfile

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

# Beam natural frequencies
freqs = result.time_values
>>> print(freq)
[ 7366.49503969  7366.49503969 11504.89523664 17285.70459456
  17285.70459457 20137.19299035]

# Get the 1st bending mode shape.  Results are ordered based on the sorted
# node numbering.  Note that results are zero indexed
nnum, disp = result.nodal_solution(0)
>>> print(disp)
[[ 2.89623914e+01 -2.82480489e+01 -3.09226692e-01]
 [ 2.89489249e+01 -2.82342416e+01  2.47536161e+01]
 [ 2.89177130e+01 -2.82745126e+01  6.05151053e+00]
 [ 2.88715048e+01 -2.82764960e+01  1.22913304e+01]
 [ 2.89221536e+01 -2.82479511e+01  1.84965333e+01]
 [ 2.89623914e+01 -2.82480489e+01  3.09226692e-01]
 ...

Plotting Nodal Results

As the geometry of the model is contained within the result file, you can plot the result without having to load any additional geometry. Below, displacement for the first mode of the modal analysis beam is plotted using VTK.

# Plot the displacement of Mode 0 in the x direction
result.plot_nodal_solution(0, 'x', label='Displacement')
https://github.com/akaszynski/pyansys/raw/master/docs/images/hexbeam_disp.png

Results can be plotted non-interactively and screenshots saved by setting up the camera and saving the result. This can help with the visualization and post-processing of a batch result.

First, get the camera position from an interactive plot:

>>> cpos = result.plot_nodal_solution(0)
>>> print(cpos)
[(5.2722879880979345, 4.308737919176047, 10.467694436036483),
 (0.5, 0.5, 2.5),
 (-0.2565529433509593, 0.9227952809887077, -0.28745339908049733)]

Then generate the plot:

result.plot_nodal_solution(0, 'x', label='Displacement', cpos=cpos,
                         screenshot='hexbeam_disp.png',
                         window_size=[800, 600], interactive=False)

Stress can be plotted as well using the below code. The nodal stress is computed in the same manner that ANSYS uses by to determine the stress at each node by averaging the stress evaluated at that node for all attached elements. For now, only component stresses can be displayed.

# Display node averaged stress in x direction for result 6
result.plot_nodal_stress(5, 'Sx')
https://github.com/akaszynski/pyansys/raw/master/docs/images/beam_stress.png

Nodal stress can also be generated non-interactively with:

result.plot_nodal_stress(5, 'Sx', cpos=cpos, screenshot=beam_stress.png,
                       window_size=[800, 600], interactive=False)

Animating a Modal Solution

Mode shapes from a modal analysis can be animated using animate_nodal_solution:

result.animate_nodal_solution(0)

If you wish to save the animation to a file, specify the movie_filename and animate it with:

result.animate_nodal_solution(0, movie_filename='/tmp/movie.mp4', cpos=cpos)
https://github.com/akaszynski/pyansys/raw/master/docs/images/beam_mode_shape.gif

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.load_km()  # returns upper triangle only

# make k, m full, symmetric matrices
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.

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.

Project details


Release history Release notifications | RSS feed

Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distributions

No source distribution files available for this release.See tutorial on generating distribution archives.

Built Distributions

pyansys-0.39.5-cp37-cp37m-win_amd64.whl (2.1 MB view details)

Uploaded CPython 3.7m Windows x86-64

pyansys-0.39.5-cp37-cp37m-manylinux1_x86_64.whl (5.0 MB view details)

Uploaded CPython 3.7m

pyansys-0.39.5-cp37-cp37m-macosx_10_9_x86_64.whl (2.3 MB view details)

Uploaded CPython 3.7m macOS 10.9+ x86-64

pyansys-0.39.5-cp36-cp36m-win_amd64.whl (2.1 MB view details)

Uploaded CPython 3.6m Windows x86-64

pyansys-0.39.5-cp36-cp36m-manylinux1_x86_64.whl (5.0 MB view details)

Uploaded CPython 3.6m

pyansys-0.39.5-cp36-cp36m-macosx_10_9_x86_64.whl (2.3 MB view details)

Uploaded CPython 3.6m macOS 10.9+ x86-64

pyansys-0.39.5-cp35-cp35m-win_amd64.whl (2.1 MB view details)

Uploaded CPython 3.5m Windows x86-64

pyansys-0.39.5-cp35-cp35m-manylinux1_x86_64.whl (4.9 MB view details)

Uploaded CPython 3.5m

File details

Details for the file pyansys-0.39.5-cp37-cp37m-win_amd64.whl.

File metadata

  • Download URL: pyansys-0.39.5-cp37-cp37m-win_amd64.whl
  • Upload date:
  • Size: 2.1 MB
  • Tags: CPython 3.7m, Windows x86-64
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/3.0.0 pkginfo/1.5.0.1 requests/2.22.0 setuptools/41.2.0 requests-toolbelt/0.9.1 tqdm/4.38.0 CPython/3.7.5

File hashes

Hashes for pyansys-0.39.5-cp37-cp37m-win_amd64.whl
Algorithm Hash digest
SHA256 da9cee74f300f692edf4a8232263ddf9611686f6b92469aa3123aa1db7d84505
MD5 e7938d3602de76ec02a9ae685c45ceb5
BLAKE2b-256 ea057dbedc389c661b208c1a0d40b0a35b15b670e95f0d28d505b29548130998

See more details on using hashes here.

File details

Details for the file pyansys-0.39.5-cp37-cp37m-manylinux1_x86_64.whl.

File metadata

  • Download URL: pyansys-0.39.5-cp37-cp37m-manylinux1_x86_64.whl
  • Upload date:
  • Size: 5.0 MB
  • Tags: CPython 3.7m
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/3.0.0 pkginfo/1.5.0.1 requests/2.22.0 setuptools/41.2.0 requests-toolbelt/0.9.1 tqdm/4.38.0 CPython/3.7.5

File hashes

Hashes for pyansys-0.39.5-cp37-cp37m-manylinux1_x86_64.whl
Algorithm Hash digest
SHA256 1019b58c9ace018810ad9d66de01a8697fdf657b2cd22b577ee3463022527f75
MD5 4ecdb5025962e619c5ee2f01bcee6f8b
BLAKE2b-256 446ca9f01b37476afd00c69c86c138419511425f60bc1effe3f75ef7cd2d1b89

See more details on using hashes here.

File details

Details for the file pyansys-0.39.5-cp37-cp37m-macosx_10_9_x86_64.whl.

File metadata

  • Download URL: pyansys-0.39.5-cp37-cp37m-macosx_10_9_x86_64.whl
  • Upload date:
  • Size: 2.3 MB
  • Tags: CPython 3.7m, macOS 10.9+ x86-64
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/3.0.0 pkginfo/1.5.0.1 requests/2.22.0 setuptools/41.6.0 requests-toolbelt/0.9.1 tqdm/4.38.0 CPython/3.7.3

File hashes

Hashes for pyansys-0.39.5-cp37-cp37m-macosx_10_9_x86_64.whl
Algorithm Hash digest
SHA256 3b640bd2163a26ce839ea1ef5f4eebd9ffb1de6c10b6467605c8b65f0d2bb92a
MD5 49cfbde9961e190edd07ccc2b05fcaac
BLAKE2b-256 16864fff09656c236c0a9c2bb4986472e645498b480a923dd8d569d4a4addcad

See more details on using hashes here.

File details

Details for the file pyansys-0.39.5-cp36-cp36m-win_amd64.whl.

File metadata

  • Download URL: pyansys-0.39.5-cp36-cp36m-win_amd64.whl
  • Upload date:
  • Size: 2.1 MB
  • Tags: CPython 3.6m, Windows x86-64
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/3.0.0 pkginfo/1.5.0.1 requests/2.22.0 setuptools/41.6.0 requests-toolbelt/0.9.1 tqdm/4.38.0 CPython/3.6.8

File hashes

Hashes for pyansys-0.39.5-cp36-cp36m-win_amd64.whl
Algorithm Hash digest
SHA256 3b7280dfb0c757fa5afcc8d792261a230cd29270978436c7d2816e4883fa0218
MD5 a460d6c08bfbd5bd8538d5e95cf40436
BLAKE2b-256 eabe519d797ecd87fadeca2c80d32847a94eb4fc3a293352beebcacef4a578b8

See more details on using hashes here.

File details

Details for the file pyansys-0.39.5-cp36-cp36m-manylinux1_x86_64.whl.

File metadata

  • Download URL: pyansys-0.39.5-cp36-cp36m-manylinux1_x86_64.whl
  • Upload date:
  • Size: 5.0 MB
  • Tags: CPython 3.6m
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/3.0.0 pkginfo/1.5.0.1 requests/2.22.0 setuptools/41.2.0 requests-toolbelt/0.9.1 tqdm/4.38.0 CPython/3.7.5

File hashes

Hashes for pyansys-0.39.5-cp36-cp36m-manylinux1_x86_64.whl
Algorithm Hash digest
SHA256 a1d1073fa144a786f9bf82888d2ab1c600409fe66ad786a2da5a2833da659ae0
MD5 9434870ff1fc5f61c02ed9c49e4a905d
BLAKE2b-256 df86afefcd48f441c699340b8caad7418ac4f1d0413f0323c84d4ad46877381e

See more details on using hashes here.

File details

Details for the file pyansys-0.39.5-cp36-cp36m-macosx_10_9_x86_64.whl.

File metadata

  • Download URL: pyansys-0.39.5-cp36-cp36m-macosx_10_9_x86_64.whl
  • Upload date:
  • Size: 2.3 MB
  • Tags: CPython 3.6m, macOS 10.9+ x86-64
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/3.0.0 pkginfo/1.5.0.1 requests/2.22.0 setuptools/41.6.0 requests-toolbelt/0.9.1 tqdm/4.38.0 CPython/3.6.8

File hashes

Hashes for pyansys-0.39.5-cp36-cp36m-macosx_10_9_x86_64.whl
Algorithm Hash digest
SHA256 efd639bde4bc3ca3d0ca442c7bf39bc13608f243836d08c35820544a8d0e96cb
MD5 101be74fd5e0920e9ac8874741fa9c89
BLAKE2b-256 fcf0cad24ed01f4da531c51a2451da2f0f63bb502aaa17cba89edf3f7251540e

See more details on using hashes here.

File details

Details for the file pyansys-0.39.5-cp35-cp35m-win_amd64.whl.

File metadata

  • Download URL: pyansys-0.39.5-cp35-cp35m-win_amd64.whl
  • Upload date:
  • Size: 2.1 MB
  • Tags: CPython 3.5m, Windows x86-64
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/1.15.0 pkginfo/1.5.0.1 requests/2.22.0 setuptools/41.6.0 requests-toolbelt/0.9.1 tqdm/4.38.0 CPython/3.5.4

File hashes

Hashes for pyansys-0.39.5-cp35-cp35m-win_amd64.whl
Algorithm Hash digest
SHA256 0dda7dda95092ca9b6643f240b1e84b5d7ad46f6884259d96eb935a9c79e4c1f
MD5 c8304e059ba88356ab7d1bc657bdd3e5
BLAKE2b-256 f38c5c2b838950b3849508a62f74885916b85861d4b6134f1f7c7328a0508e87

See more details on using hashes here.

File details

Details for the file pyansys-0.39.5-cp35-cp35m-manylinux1_x86_64.whl.

File metadata

  • Download URL: pyansys-0.39.5-cp35-cp35m-manylinux1_x86_64.whl
  • Upload date:
  • Size: 4.9 MB
  • Tags: CPython 3.5m
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/3.0.0 pkginfo/1.5.0.1 requests/2.22.0 setuptools/41.2.0 requests-toolbelt/0.9.1 tqdm/4.38.0 CPython/3.7.5

File hashes

Hashes for pyansys-0.39.5-cp35-cp35m-manylinux1_x86_64.whl
Algorithm Hash digest
SHA256 3131b2b7751efd708b44bf17e0f6b4c9ea73cdca144c247a2e1a69705c53718b
MD5 3aab43018ef513dfc88feab78fab3b01
BLAKE2b-256 d4c2cccb9d6c9a94081b1241d3529c8e75fbaef90e36f724b2c2e1065a0293fd

See more details on using hashes here.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page