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.6-cp37-cp37m-win_amd64.whl (2.1 MB view details)

Uploaded CPython 3.7m Windows x86-64

pyansys-0.39.6-cp37-cp37m-manylinux1_x86_64.whl (4.7 MB view details)

Uploaded CPython 3.7m

pyansys-0.39.6-cp37-cp37m-macosx_10_9_x86_64.whl (2.2 MB view details)

Uploaded CPython 3.7m macOS 10.9+ x86-64

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

Uploaded CPython 3.6m Windows x86-64

pyansys-0.39.6-cp36-cp36m-manylinux1_x86_64.whl (4.7 MB view details)

Uploaded CPython 3.6m

pyansys-0.39.6-cp36-cp36m-macosx_10_9_x86_64.whl (2.2 MB view details)

Uploaded CPython 3.6m macOS 10.9+ x86-64

pyansys-0.39.6-cp35-cp35m-win_amd64.whl (2.0 MB view details)

Uploaded CPython 3.5m Windows x86-64

pyansys-0.39.6-cp35-cp35m-manylinux1_x86_64.whl (4.7 MB view details)

Uploaded CPython 3.5m

File details

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

File metadata

  • Download URL: pyansys-0.39.6-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.1.1 pkginfo/1.5.0.1 requests/2.22.0 setuptools/41.2.0 requests-toolbelt/0.9.1 tqdm/4.39.0 CPython/3.7.5

File hashes

Hashes for pyansys-0.39.6-cp37-cp37m-win_amd64.whl
Algorithm Hash digest
SHA256 327eb40131f381dc69ea873f41786b774a42201432e652e5242b6888406682c6
MD5 df2a549ec0f4c3ee11a1c2f6dbbcc87c
BLAKE2b-256 c2c3b105c9a67245ecd1cba35cd9ce17379b3e6ba89a0bd4a1265df39c947d2e

See more details on using hashes here.

File details

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

File metadata

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

File hashes

Hashes for pyansys-0.39.6-cp37-cp37m-manylinux1_x86_64.whl
Algorithm Hash digest
SHA256 d781c70c9a9c788c971fe58c8bb93c0c027b9ef3b2490185bc87c72068d76c72
MD5 4676cad2ef8ad03b325001517b31ca27
BLAKE2b-256 ea3c975f47756028de7556a424e8986ca025cf097c95f4b1f05a9811a6551627

See more details on using hashes here.

File details

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

File metadata

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

File hashes

Hashes for pyansys-0.39.6-cp37-cp37m-macosx_10_9_x86_64.whl
Algorithm Hash digest
SHA256 74955bf6e59524f0eab77bf483286424923a07f6b7dff1f5a50e6e955156bb71
MD5 1aa4aead129b1d3eb04f7f27d2d7b1c6
BLAKE2b-256 30ce97aa92467730afe0941d6a3d5bf64c9a00589972282e8d3806f553b50f6e

See more details on using hashes here.

File details

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

File metadata

  • Download URL: pyansys-0.39.6-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.1.1 pkginfo/1.5.0.1 requests/2.22.0 setuptools/42.0.1 requests-toolbelt/0.9.1 tqdm/4.39.0 CPython/3.6.8

File hashes

Hashes for pyansys-0.39.6-cp36-cp36m-win_amd64.whl
Algorithm Hash digest
SHA256 90cc2d7a832caaf8d56d2a27b019e8629dc82ed119f40b7885fb38cd78890154
MD5 eea977ee7120af5d3545f6adf16dcc76
BLAKE2b-256 e36e853011a6e478b881ad59fb5f9e63b48342a3ab39d3aae65bc1fb4dc4773d

See more details on using hashes here.

File details

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

File metadata

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

File hashes

Hashes for pyansys-0.39.6-cp36-cp36m-manylinux1_x86_64.whl
Algorithm Hash digest
SHA256 087ae63a339b1d128a9720b58b0fde26039abc3f513bb32a329d51282b220f8d
MD5 5ef1e18fe158b0215cbcd252e464ec1f
BLAKE2b-256 c2dd0c6649f836f429a7a4144af765047fa357e400b7ae13a680d8a9d7833bac

See more details on using hashes here.

File details

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

File metadata

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

File hashes

Hashes for pyansys-0.39.6-cp36-cp36m-macosx_10_9_x86_64.whl
Algorithm Hash digest
SHA256 02095d80ff10c0fe195dc2cdd21571a1c39f69980d305cfc6d77b3b5feae23e8
MD5 2db9af78bdddfde1e2b83faeea469166
BLAKE2b-256 8e0539ecf0bebf19aa600ad5d030211bc24d681b79acbe747ed8477efdb101a3

See more details on using hashes here.

File details

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

File metadata

  • Download URL: pyansys-0.39.6-cp35-cp35m-win_amd64.whl
  • Upload date:
  • Size: 2.0 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/42.0.1 requests-toolbelt/0.9.1 tqdm/4.39.0 CPython/3.5.4

File hashes

Hashes for pyansys-0.39.6-cp35-cp35m-win_amd64.whl
Algorithm Hash digest
SHA256 b368f90b2bb59e4e64888b94c1b7caec04b1dd98e5396d810a7ee2269914f6e1
MD5 05b77c65e650d7467b67e40914199e6c
BLAKE2b-256 05099e6ed4e92fbb3568bff6db00895d66b31b22db17c3579aa679346b9fe30b

See more details on using hashes here.

File details

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

File metadata

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

File hashes

Hashes for pyansys-0.39.6-cp35-cp35m-manylinux1_x86_64.whl
Algorithm Hash digest
SHA256 80f3fe4f01c3786cdd7eadedf3af3183078260c785abfcafd4a4e737064f102e
MD5 40775fcfc8b077a48c51e8c742edf9e0
BLAKE2b-256 f3b06ab6a4c4474d509df6c6b655206ffa916e372b0e1a0056caf377ee4d90d9

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