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()
mapdl = pyansys.launch_mapdl(run_location=path, interactive_plotting=True)

# create a square area using keypoints
mapdl.prep7()
mapdl.k(1, 0, 0, 0)
mapdl.k(2, 1, 0, 0)
mapdl.k(3, 1, 1, 0)
mapdl.k(4, 0, 1, 0)
mapdl.l(1, 2)
mapdl.l(2, 3)
mapdl.l(3, 4)
mapdl.l(4, 1)
mapdl.al(1, 2, 3, 4)
mapdl.aplot()
mapdl.save()
mapdl.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: Macros for repeating tasks

  • The geo2d class: Easily create 2d geometries

You can also install pyansystools with

` pip install pyansystools `

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.

To get a copy of ANSYS, please visit 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 Distribution

pyansys-0.41.8.tar.gz (2.1 MB view details)

Uploaded Source

Built Distributions

pyansys-0.41.8-cp38-cp38-win_amd64.whl (1.8 MB view details)

Uploaded CPython 3.8 Windows x86-64

pyansys-0.41.8-cp38-cp38-manylinux1_x86_64.whl (4.1 MB view details)

Uploaded CPython 3.8

pyansys-0.41.8-cp38-cp38-macosx_10_9_x86_64.whl (1.9 MB view details)

Uploaded CPython 3.8 macOS 10.9+ x86-64

pyansys-0.41.8-cp37-cp37m-win_amd64.whl (1.8 MB view details)

Uploaded CPython 3.7m Windows x86-64

pyansys-0.41.8-cp37-cp37m-manylinux1_x86_64.whl (3.6 MB view details)

Uploaded CPython 3.7m

pyansys-0.41.8-cp37-cp37m-macosx_10_9_x86_64.whl (1.9 MB view details)

Uploaded CPython 3.7m macOS 10.9+ x86-64

pyansys-0.41.8-cp36-cp36m-win_amd64.whl (1.8 MB view details)

Uploaded CPython 3.6m Windows x86-64

pyansys-0.41.8-cp36-cp36m-manylinux1_x86_64.whl (3.6 MB view details)

Uploaded CPython 3.6m

pyansys-0.41.8-cp36-cp36m-macosx_10_9_x86_64.whl (1.9 MB view details)

Uploaded CPython 3.6m macOS 10.9+ x86-64

pyansys-0.41.8-cp35-cp35m-win_amd64.whl (1.8 MB view details)

Uploaded CPython 3.5m Windows x86-64

pyansys-0.41.8-cp35-cp35m-manylinux1_x86_64.whl (3.6 MB view details)

Uploaded CPython 3.5m

File details

Details for the file pyansys-0.41.8.tar.gz.

File metadata

  • Download URL: pyansys-0.41.8.tar.gz
  • Upload date:
  • Size: 2.1 MB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/3.2.0 pkginfo/1.5.0.1 requests/2.24.0 setuptools/41.2.0 requests-toolbelt/0.9.1 tqdm/4.47.0 CPython/3.7.7

File hashes

Hashes for pyansys-0.41.8.tar.gz
Algorithm Hash digest
SHA256 016ff06004592aa6fec60218d35d4cc4be5ff361df7d69ad1c30e34b857ab2b8
MD5 ff140225d442ca3fffaf38dcb8415bc3
BLAKE2b-256 41728f44f90c5a69925d6ae2a51a660e520c7594d015a5b405c3ba6230b772af

See more details on using hashes here.

File details

Details for the file pyansys-0.41.8-cp38-cp38-win_amd64.whl.

File metadata

  • Download URL: pyansys-0.41.8-cp38-cp38-win_amd64.whl
  • Upload date:
  • Size: 1.8 MB
  • Tags: CPython 3.8, Windows x86-64
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/3.2.0 pkginfo/1.5.0.1 requests/2.24.0 setuptools/41.2.0 requests-toolbelt/0.9.1 tqdm/4.47.0 CPython/3.8.3

File hashes

Hashes for pyansys-0.41.8-cp38-cp38-win_amd64.whl
Algorithm Hash digest
SHA256 a0aa224043e6aa8612c659432bb67429f93acdb826acbb4d9c4d60430cc02a63
MD5 f552ddb4c48a1a85da7c9c2624bdc1c1
BLAKE2b-256 2a64ae2f3cdba8cc2de93b9ebfa0bfbae1ae9cddb9ca23e0cf464015962a30f4

See more details on using hashes here.

File details

Details for the file pyansys-0.41.8-cp38-cp38-manylinux1_x86_64.whl.

File metadata

  • Download URL: pyansys-0.41.8-cp38-cp38-manylinux1_x86_64.whl
  • Upload date:
  • Size: 4.1 MB
  • Tags: CPython 3.8
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/3.2.0 pkginfo/1.5.0.1 requests/2.24.0 setuptools/41.2.0 requests-toolbelt/0.9.1 tqdm/4.47.0 CPython/3.8.3

File hashes

Hashes for pyansys-0.41.8-cp38-cp38-manylinux1_x86_64.whl
Algorithm Hash digest
SHA256 d87f6d8271bf9cb633b08af4c727f4e09dce4d2123bcf656848675ad989a2ec1
MD5 269372d40d5333140f20937ed7740680
BLAKE2b-256 b1114875bcecf7b386a1384d8f0a3d3ea630f5a9dcb3e88e74cf31c499a8e4f7

See more details on using hashes here.

File details

Details for the file pyansys-0.41.8-cp38-cp38-macosx_10_9_x86_64.whl.

File metadata

  • Download URL: pyansys-0.41.8-cp38-cp38-macosx_10_9_x86_64.whl
  • Upload date:
  • Size: 1.9 MB
  • Tags: CPython 3.8, macOS 10.9+ x86-64
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/3.2.0 pkginfo/1.5.0.1 requests/2.24.0 setuptools/41.2.0 requests-toolbelt/0.9.1 tqdm/4.47.0 CPython/3.8.3

File hashes

Hashes for pyansys-0.41.8-cp38-cp38-macosx_10_9_x86_64.whl
Algorithm Hash digest
SHA256 c9a802e16b14778031071a0604e1316c355855f7b648f8a836d1862f3f464268
MD5 e08889dd4e4fd2ae1057b601f8676464
BLAKE2b-256 60021215a4678baca08eda5e9e48e3a6f194a47954fe4588e457a2e09f4d219d

See more details on using hashes here.

File details

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

File metadata

  • Download URL: pyansys-0.41.8-cp37-cp37m-win_amd64.whl
  • Upload date:
  • Size: 1.8 MB
  • Tags: CPython 3.7m, Windows x86-64
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/3.2.0 pkginfo/1.5.0.1 requests/2.24.0 setuptools/41.2.0 requests-toolbelt/0.9.1 tqdm/4.47.0 CPython/3.7.7

File hashes

Hashes for pyansys-0.41.8-cp37-cp37m-win_amd64.whl
Algorithm Hash digest
SHA256 a36dd7d9a2bd8dd0ae811de3cc803cb36668f896341f621c83c7ced7b44c1ec0
MD5 7a485785ef4af6900b54cf1a68a41fda
BLAKE2b-256 caaef5c2cc46684cc16845a3811e28861eced561b1527f40add7c07a4d1f4951

See more details on using hashes here.

File details

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

File metadata

  • Download URL: pyansys-0.41.8-cp37-cp37m-manylinux1_x86_64.whl
  • Upload date:
  • Size: 3.6 MB
  • Tags: CPython 3.7m
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/3.2.0 pkginfo/1.5.0.1 requests/2.24.0 setuptools/41.2.0 requests-toolbelt/0.9.1 tqdm/4.47.0 CPython/3.7.7

File hashes

Hashes for pyansys-0.41.8-cp37-cp37m-manylinux1_x86_64.whl
Algorithm Hash digest
SHA256 9d9f3206bfb541c6d0985282df66470b8dc69c5dc936d80b50091edc19383dc1
MD5 b3039e75d7e68ffb47a984a92a3bc536
BLAKE2b-256 a9214b5c1379fab6d95c5662c4559df8630b562a947d1ebd80b90089c2a57799

See more details on using hashes here.

File details

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

File metadata

  • Download URL: pyansys-0.41.8-cp37-cp37m-macosx_10_9_x86_64.whl
  • Upload date:
  • Size: 1.9 MB
  • Tags: CPython 3.7m, macOS 10.9+ x86-64
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/3.2.0 pkginfo/1.5.0.1 requests/2.24.0 setuptools/41.2.0 requests-toolbelt/0.9.1 tqdm/4.47.0 CPython/3.7.7

File hashes

Hashes for pyansys-0.41.8-cp37-cp37m-macosx_10_9_x86_64.whl
Algorithm Hash digest
SHA256 7151d5f141fed7baf1b1b22070520a73f69242cf2dbb4c12d691720123d6e5d0
MD5 71aad5c8cb9c33a10c051d0b41c6926b
BLAKE2b-256 7216a9b470c666b1583b7de4504dfd0d81ba3de33ee47ade0bef6ec14fa027a5

See more details on using hashes here.

File details

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

File metadata

  • Download URL: pyansys-0.41.8-cp36-cp36m-win_amd64.whl
  • Upload date:
  • Size: 1.8 MB
  • Tags: CPython 3.6m, Windows x86-64
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/3.2.0 pkginfo/1.5.0.1 requests/2.24.0 setuptools/49.1.0 requests-toolbelt/0.9.1 tqdm/4.47.0 CPython/3.6.8

File hashes

Hashes for pyansys-0.41.8-cp36-cp36m-win_amd64.whl
Algorithm Hash digest
SHA256 629c73aa32b241eeaeca63a1fe91d3100cc43ab85e1ec18ffaeb420a736143d2
MD5 ed33abe85364ce72b13e8fc968d29893
BLAKE2b-256 fc70c91b8e06b8baf13a8ae2c4246b4d38a324b5ecb2c890c164115be46aa0c5

See more details on using hashes here.

File details

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

File metadata

  • Download URL: pyansys-0.41.8-cp36-cp36m-manylinux1_x86_64.whl
  • Upload date:
  • Size: 3.6 MB
  • Tags: CPython 3.6m
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/3.2.0 pkginfo/1.5.0.1 requests/2.24.0 setuptools/40.6.2 requests-toolbelt/0.9.1 tqdm/4.47.0 CPython/3.6.10

File hashes

Hashes for pyansys-0.41.8-cp36-cp36m-manylinux1_x86_64.whl
Algorithm Hash digest
SHA256 9236dfc5b9d163d9fae84179b76aa08679b1bf942580982e5bc41c529d7e8549
MD5 23cdff1a0985c7c42a0a9a98afd2dee1
BLAKE2b-256 11488a7c5dfd144793847b23e36ef51b926da39f3e8c2f867dd6543f1e444d55

See more details on using hashes here.

File details

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

File metadata

  • Download URL: pyansys-0.41.8-cp36-cp36m-macosx_10_9_x86_64.whl
  • Upload date:
  • Size: 1.9 MB
  • Tags: CPython 3.6m, macOS 10.9+ x86-64
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/3.2.0 pkginfo/1.5.0.1 requests/2.24.0 setuptools/49.1.0 requests-toolbelt/0.9.1 tqdm/4.47.0 CPython/3.6.8

File hashes

Hashes for pyansys-0.41.8-cp36-cp36m-macosx_10_9_x86_64.whl
Algorithm Hash digest
SHA256 8ccd6b292eb8b9fb4efd2d579cbae554192ce21bfaa43429b3a17fef4c9c5439
MD5 cc457590150ea2040a7dec3fee30745b
BLAKE2b-256 3fc5baff44adfd4842392bd803226c0b12b64163b1425b0a76488e5746d04dd8

See more details on using hashes here.

File details

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

File metadata

  • Download URL: pyansys-0.41.8-cp35-cp35m-win_amd64.whl
  • Upload date:
  • Size: 1.8 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.24.0 setuptools/49.1.0 requests-toolbelt/0.9.1 tqdm/4.47.0 CPython/3.5.4

File hashes

Hashes for pyansys-0.41.8-cp35-cp35m-win_amd64.whl
Algorithm Hash digest
SHA256 c1e05256d1a1a64782e52eb2daa2084dc015da76142a86a1094e45e619b26a05
MD5 45630ccf9002317c0a04ba91d34101b9
BLAKE2b-256 858340683b40e1e235705f9b79568852ef899eca6ea2f1e3ebe141cf45b1e975

See more details on using hashes here.

File details

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

File metadata

  • Download URL: pyansys-0.41.8-cp35-cp35m-manylinux1_x86_64.whl
  • Upload date:
  • Size: 3.6 MB
  • Tags: CPython 3.5m
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/1.15.0 pkginfo/1.5.0.1 requests/2.24.0 setuptools/28.8.0 requests-toolbelt/0.9.1 tqdm/4.47.0 CPython/3.5.9

File hashes

Hashes for pyansys-0.41.8-cp35-cp35m-manylinux1_x86_64.whl
Algorithm Hash digest
SHA256 09bec8f1885f13e664d2563e9906639432cc2b83d5c92ad78731d443596e5bee
MD5 4d116d1f06b3e8e17ed04c1ce8bad0de
BLAKE2b-256 009cbb658d50c3f8b73c857217f7f32735a307046b21f5a9702f073c53f0f71c

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