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

Additional Tools

There are additional tools created by @natter1 at pyansysTools which include the following features:

  • Inline class, implementing the ANSYS inline functions

  • Macros class, with macros for repeating tasks (right now, it’s only one macro for creating symmetric contact pairs)

  • The geo2d class, to easily create 2d geometries

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

Uploaded CPython 3.7m Windows x86-64

pyansys-0.39.9-cp37-cp37m-manylinux1_x86_64.whl (4.8 MB view details)

Uploaded CPython 3.7m

pyansys-0.39.9-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.9-cp36-cp36m-win_amd64.whl (2.1 MB view details)

Uploaded CPython 3.6m Windows x86-64

pyansys-0.39.9-cp36-cp36m-manylinux1_x86_64.whl (4.8 MB view details)

Uploaded CPython 3.6m

pyansys-0.39.9-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.9-cp35-cp35m-win_amd64.whl (2.0 MB view details)

Uploaded CPython 3.5m Windows x86-64

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

Uploaded CPython 3.5m

File details

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

File metadata

  • Download URL: pyansys-0.39.9-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.40.0 CPython/3.7.5

File hashes

Hashes for pyansys-0.39.9-cp37-cp37m-win_amd64.whl
Algorithm Hash digest
SHA256 75450ecd59fc64804ddb87a04f7fa796f0cce233abfb4aacd77af45b5e8b72f1
MD5 ca925cdbe16c3249a15faa6d76f432e0
BLAKE2b-256 1e9320d52b872e34fb954f56dfcad102f4030dd2ab10bfa97ff86347f4191f54

See more details on using hashes here.

File details

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

File metadata

  • Download URL: pyansys-0.39.9-cp37-cp37m-manylinux1_x86_64.whl
  • Upload date:
  • Size: 4.8 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.40.0 CPython/3.7.5

File hashes

Hashes for pyansys-0.39.9-cp37-cp37m-manylinux1_x86_64.whl
Algorithm Hash digest
SHA256 a0bb3fed6746b153a45218b25b32e11b2ed0ab287ea4385a033e32cbbdb2de6b
MD5 a85c27501b69e0d5ac1be2f6e9f85267
BLAKE2b-256 06bef1e742ead107620cf4c4812673be9e03d74f3ce32fa094084b5eeda45733

See more details on using hashes here.

File details

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

File metadata

  • Download URL: pyansys-0.39.9-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.2 requests-toolbelt/0.9.1 tqdm/4.40.0 CPython/3.7.3

File hashes

Hashes for pyansys-0.39.9-cp37-cp37m-macosx_10_9_x86_64.whl
Algorithm Hash digest
SHA256 ba4ef19a40849ce359b07b9da3da7c0fc341f0594b36cf3042d836623ba58643
MD5 fb53604456ff95619707c28eb1c55db7
BLAKE2b-256 3c65cc37cc78af74a6275ebcf6cd5de1b85790fece9684f3ab29aee159418d25

See more details on using hashes here.

File details

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

File metadata

  • Download URL: pyansys-0.39.9-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.2 requests-toolbelt/0.9.1 tqdm/4.40.0 CPython/3.6.8

File hashes

Hashes for pyansys-0.39.9-cp36-cp36m-win_amd64.whl
Algorithm Hash digest
SHA256 65c26d3193309409a09b2c9bbf33011c328ba7df02ed696fdb86c77693f46425
MD5 682d4cab4d8e360b64b72427fdf940ce
BLAKE2b-256 c325bd942d905b20d483ba943c8b78fbe4a15cff8dffd9862638389d38946033

See more details on using hashes here.

File details

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

File metadata

  • Download URL: pyansys-0.39.9-cp36-cp36m-manylinux1_x86_64.whl
  • Upload date:
  • Size: 4.8 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.40.0 CPython/3.7.5

File hashes

Hashes for pyansys-0.39.9-cp36-cp36m-manylinux1_x86_64.whl
Algorithm Hash digest
SHA256 7a7775fbb58a9ee99178162aac482390ed12078b1a4c7ec206a56b0e6213dd4e
MD5 54ff7098fa4322b19357306cc71ec29d
BLAKE2b-256 644343fe84819b83af74a66d311335bcb7d58a1ae63c4bf162089378ac1eaff8

See more details on using hashes here.

File details

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

File metadata

  • Download URL: pyansys-0.39.9-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.2 requests-toolbelt/0.9.1 tqdm/4.40.0 CPython/3.6.8

File hashes

Hashes for pyansys-0.39.9-cp36-cp36m-macosx_10_9_x86_64.whl
Algorithm Hash digest
SHA256 51c8cdc09c3f96e17bc3ab1cfdcfd254fc843d7cca76d5ba9fb18f121da75783
MD5 c509fc1569da8422086f33db2d035b22
BLAKE2b-256 2c7eff99bc5f0e389dcf5f008db1bd28ff7e543ddf54431bcf972aff69ba7b2d

See more details on using hashes here.

File details

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

File metadata

  • Download URL: pyansys-0.39.9-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.2 requests-toolbelt/0.9.1 tqdm/4.40.0 CPython/3.5.4

File hashes

Hashes for pyansys-0.39.9-cp35-cp35m-win_amd64.whl
Algorithm Hash digest
SHA256 e05eceeb7837058cdabe98ad03b1d339837bff612199cce476839ea02e1b5892
MD5 c1153f88304db642353886b7e64cc7fd
BLAKE2b-256 dfdf829671e34e71f685bbf14f1dfd4f031981ba23a68e860fb5766acadf5338

See more details on using hashes here.

File details

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

File metadata

  • Download URL: pyansys-0.39.9-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.40.0 CPython/3.7.5

File hashes

Hashes for pyansys-0.39.9-cp35-cp35m-manylinux1_x86_64.whl
Algorithm Hash digest
SHA256 0837df9d01767cd1de155e5c1aad5266ea1e5308f49e809798410bc5aba55015
MD5 2127dcb9dc1a1401103a778ab4f62e61
BLAKE2b-256 bf1a81e4d55f95f4d2a796d11108ce7405142a69b8cc07625e8e379677dc3559

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