Skip to main content

Pythonic interface to files generated by MAPDL

Project description

PyAnsys pypi PyPIact GH-CI MIT black pre-commit.ci status

This is the legacy module for reading in binary and ASCII files generated from MAPDL.

This Python module allows you to extract data directly from binary ANSYS v14.5+ files and to display or animate them rapidly using a straightforward API coupled with C libraries based on header files provided by ANSYS.

The ansys-mapdl-reader module supports the following formats:

  • *.rst - Structural analysis result file

  • *.rth - Thermal analysis result file

  • *.emat - Element matrix data file

  • *.full - Full stiffness-mass matrix file

  • *.cdb or *.dat - MAPDL ASCII block archive and Mechanical Workbench input files

Please see the PyMAPDL-Reader Documentation for the full documentation.

Installation

Installation through pip:

pip install ansys-mapdl-reader

You can also visit pymapdl-reader to download the source or releases from GitHub.

Examples

Loading and Plotting a MAPDL Archive File

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

from ansys.mapdl import reader as pymapdl_reader
from ansys.mapdl.reader import examples

# Sample *.cdb
filename = examples.hexarchivefile

# Read ansys archive file
archive = pymapdl_reader.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')
Hexahedral beam

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
from ansys.mapdl import reader as pymapdl_reader
from ansys.mapdl.reader import examples

# Sample result file
rstfile = examples.rstfile

# Create result object by loading the result file
result = pymapdl_reader.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/ansys/pymapdl-reader/blob/main/doc/source/images/hexbeam_disp_small.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/ansys/pymapdl-reader/blob/main/doc/source/images/beam_stress_small.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)
Modal shape animation

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)

Reading a Full File

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

# Load the reader from pyansys
from ansys.mapdl import reader as pymapdl_reader
from scipy import sparse

# load the full file
fobj = pymapdl_reader.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

Developing on Windows

This package is designed to be developed on Linux, and if you need to develop on Windows you will need to install your own C++ compiler. We recommend:

  1. Install Visual C++
    1. See here for a list of which Python versions correspond to which Visual C++ version

  2. Install the development version of pymapdl-reader to your Python environment
    1. Navigate to the project’s top level (the same directory as this README)

    2. run pip install -e .

License and Acknowledgments

The ansys-mapdl-reader library is licensed under the MIT license.

Project details


Download files

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

Source Distribution

ansys_mapdl_reader-0.55.1.tar.gz (644.2 kB view details)

Uploaded Source

Built Distributions

ansys_mapdl_reader-0.55.1-cp313-cp313-win_amd64.whl (1.1 MB view details)

Uploaded CPython 3.13Windows x86-64

ansys_mapdl_reader-0.55.1-cp313-cp313-manylinux_2_17_x86_64.manylinux2014_x86_64.whl (4.3 MB view details)

Uploaded CPython 3.13manylinux: glibc 2.17+ x86-64

ansys_mapdl_reader-0.55.1-cp313-cp313-macosx_10_13_x86_64.whl (1.2 MB view details)

Uploaded CPython 3.13macOS 10.13+ x86-64

ansys_mapdl_reader-0.55.1-cp313-cp313-macosx_10_13_universal2.whl (1.8 MB view details)

Uploaded CPython 3.13macOS 10.13+ universal2 (ARM64, x86-64)

ansys_mapdl_reader-0.55.1-cp312-cp312-win_amd64.whl (1.1 MB view details)

Uploaded CPython 3.12Windows x86-64

ansys_mapdl_reader-0.55.1-cp312-cp312-manylinux_2_17_x86_64.manylinux2014_x86_64.whl (4.3 MB view details)

Uploaded CPython 3.12manylinux: glibc 2.17+ x86-64

ansys_mapdl_reader-0.55.1-cp312-cp312-macosx_10_13_x86_64.whl (1.2 MB view details)

Uploaded CPython 3.12macOS 10.13+ x86-64

ansys_mapdl_reader-0.55.1-cp312-cp312-macosx_10_13_universal2.whl (1.8 MB view details)

Uploaded CPython 3.12macOS 10.13+ universal2 (ARM64, x86-64)

ansys_mapdl_reader-0.55.1-cp311-cp311-win_amd64.whl (1.1 MB view details)

Uploaded CPython 3.11Windows x86-64

ansys_mapdl_reader-0.55.1-cp311-cp311-manylinux_2_17_x86_64.manylinux2014_x86_64.whl (4.5 MB view details)

Uploaded CPython 3.11manylinux: glibc 2.17+ x86-64

ansys_mapdl_reader-0.55.1-cp311-cp311-macosx_10_9_x86_64.whl (1.2 MB view details)

Uploaded CPython 3.11macOS 10.9+ x86-64

ansys_mapdl_reader-0.55.1-cp311-cp311-macosx_10_9_universal2.whl (1.8 MB view details)

Uploaded CPython 3.11macOS 10.9+ universal2 (ARM64, x86-64)

ansys_mapdl_reader-0.55.1-cp310-cp310-win_amd64.whl (1.1 MB view details)

Uploaded CPython 3.10Windows x86-64

ansys_mapdl_reader-0.55.1-cp310-cp310-manylinux_2_17_x86_64.manylinux2014_x86_64.whl (4.3 MB view details)

Uploaded CPython 3.10manylinux: glibc 2.17+ x86-64

ansys_mapdl_reader-0.55.1-cp310-cp310-macosx_10_9_x86_64.whl (1.2 MB view details)

Uploaded CPython 3.10macOS 10.9+ x86-64

ansys_mapdl_reader-0.55.1-cp310-cp310-macosx_10_9_universal2.whl (1.8 MB view details)

Uploaded CPython 3.10macOS 10.9+ universal2 (ARM64, x86-64)

File details

Details for the file ansys_mapdl_reader-0.55.1.tar.gz.

File metadata

  • Download URL: ansys_mapdl_reader-0.55.1.tar.gz
  • Upload date:
  • Size: 644.2 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.1.0 CPython/3.13.3

File hashes

Hashes for ansys_mapdl_reader-0.55.1.tar.gz
Algorithm Hash digest
SHA256 8c0683319180bb2a86214465ac40bf10d4150500a8ff290e438433ab67313a62
MD5 0d8f24bb15313584109bfadc7d23733b
BLAKE2b-256 2eb91e895f57dcd64769e74b799981a2a718482e24fd76ba505b714c34879e56

See more details on using hashes here.

File details

Details for the file ansys_mapdl_reader-0.55.1-cp313-cp313-win_amd64.whl.

File metadata

File hashes

Hashes for ansys_mapdl_reader-0.55.1-cp313-cp313-win_amd64.whl
Algorithm Hash digest
SHA256 0f1aebc1699b4162062505a769a2ca4aa92e1a9e94b2f2d55fe744a2775a4b51
MD5 adf7bad925af78e695c80990716a7228
BLAKE2b-256 e8bc3b9ad381882d9a04b1c28514f52fa476f3f46de05c1828b8dc128d7b08bf

See more details on using hashes here.

File details

Details for the file ansys_mapdl_reader-0.55.1-cp313-cp313-manylinux_2_17_x86_64.manylinux2014_x86_64.whl.

File metadata

File hashes

Hashes for ansys_mapdl_reader-0.55.1-cp313-cp313-manylinux_2_17_x86_64.manylinux2014_x86_64.whl
Algorithm Hash digest
SHA256 6400978f42094311ecc9c7ce433c1a2c018e7da41f3c24b3d9d30528afe5b7b2
MD5 1ecc997e3b28545e78463bdc3bb0fe78
BLAKE2b-256 ab600ac620912eec1f3bdf46370a7c7ec745fdc128e418d3f9cfff19c945ad7a

See more details on using hashes here.

File details

Details for the file ansys_mapdl_reader-0.55.1-cp313-cp313-macosx_10_13_x86_64.whl.

File metadata

File hashes

Hashes for ansys_mapdl_reader-0.55.1-cp313-cp313-macosx_10_13_x86_64.whl
Algorithm Hash digest
SHA256 cf4df5791321e09224bb870a100f97943de9f260c8759d06a65ccda079890fe0
MD5 5c915a765f4bd7b1d3a2bb8c66b9b852
BLAKE2b-256 796c7a2d527d7111e613878fd10e64a5ff485e8d6580f7adba39b8ec6d6c46dd

See more details on using hashes here.

File details

Details for the file ansys_mapdl_reader-0.55.1-cp313-cp313-macosx_10_13_universal2.whl.

File metadata

File hashes

Hashes for ansys_mapdl_reader-0.55.1-cp313-cp313-macosx_10_13_universal2.whl
Algorithm Hash digest
SHA256 6bc4a5b12ae7776c0598083e8fd778632222ba5e7f096c02bc59d8ddf8924114
MD5 a2525f26c79bd7ee5fa09f520d837f6f
BLAKE2b-256 90abe775f1fd5e2ae84f98a43a00bda606320ce41ba728c0c9ecbbef91edb272

See more details on using hashes here.

File details

Details for the file ansys_mapdl_reader-0.55.1-cp312-cp312-win_amd64.whl.

File metadata

File hashes

Hashes for ansys_mapdl_reader-0.55.1-cp312-cp312-win_amd64.whl
Algorithm Hash digest
SHA256 b6ca8e920cd4bf53ae642fa7c24cfdfec0c080f3959943b5c084055ff522ca06
MD5 c39431b88dc34345ba23ddd84e980c46
BLAKE2b-256 18050de00989f5731b15c0cd5abf7686f556158840849cc9865a389fd6f9c0ec

See more details on using hashes here.

File details

Details for the file ansys_mapdl_reader-0.55.1-cp312-cp312-manylinux_2_17_x86_64.manylinux2014_x86_64.whl.

File metadata

File hashes

Hashes for ansys_mapdl_reader-0.55.1-cp312-cp312-manylinux_2_17_x86_64.manylinux2014_x86_64.whl
Algorithm Hash digest
SHA256 2ce1344564e5fdca3afc60c4cc6098187851c77268c50cce70c8e7673b940876
MD5 14886b34c0aca3661b23729bf2761aba
BLAKE2b-256 c8048bd3ecd9b9696fe5ecd097a58dbb13bfc1743b24a23ff7b422d88197734c

See more details on using hashes here.

File details

Details for the file ansys_mapdl_reader-0.55.1-cp312-cp312-macosx_10_13_x86_64.whl.

File metadata

File hashes

Hashes for ansys_mapdl_reader-0.55.1-cp312-cp312-macosx_10_13_x86_64.whl
Algorithm Hash digest
SHA256 6a40a33dee28a980d012dd26f57a3801e63abd18650bf0f8bb69e0f66575c50f
MD5 9fef95ff2b7ef4686f38d054df5a5313
BLAKE2b-256 00a50e35343b83f37c6c348887cc7a58a835d0915057081ea3fff20f55ed46a0

See more details on using hashes here.

File details

Details for the file ansys_mapdl_reader-0.55.1-cp312-cp312-macosx_10_13_universal2.whl.

File metadata

File hashes

Hashes for ansys_mapdl_reader-0.55.1-cp312-cp312-macosx_10_13_universal2.whl
Algorithm Hash digest
SHA256 b8245faa5af92965e0c99935637dad2c023bdf3709aa48709276d7c215aaac8e
MD5 3c9b5375c50dd12edb9d3148689eb2e7
BLAKE2b-256 00b45b347db92646b2c99793bb93c317518a30ac2fab887f897400177218091a

See more details on using hashes here.

File details

Details for the file ansys_mapdl_reader-0.55.1-cp311-cp311-win_amd64.whl.

File metadata

File hashes

Hashes for ansys_mapdl_reader-0.55.1-cp311-cp311-win_amd64.whl
Algorithm Hash digest
SHA256 6c3b8df2209cb5c2a4e05196a4c6c85b4eeee1b27b0183e32f80ec489cee52a4
MD5 6a51d56cdd518e2ea71adfe98f116de1
BLAKE2b-256 d562be120c6a63bdd172d0071bf524456fb23d333715f14ff3ffa1cfa3a2f625

See more details on using hashes here.

File details

Details for the file ansys_mapdl_reader-0.55.1-cp311-cp311-manylinux_2_17_x86_64.manylinux2014_x86_64.whl.

File metadata

File hashes

Hashes for ansys_mapdl_reader-0.55.1-cp311-cp311-manylinux_2_17_x86_64.manylinux2014_x86_64.whl
Algorithm Hash digest
SHA256 c341f2c9e51741d3fd670dedaeee07db705b2cc1715d2e4e3337a9d8623c5af1
MD5 42d2ed8fbf18d66c828aa70deab9a12e
BLAKE2b-256 348654d5afb8c875ebd98ced4a4afb5c324cd247f5599d87004849edb04618d6

See more details on using hashes here.

File details

Details for the file ansys_mapdl_reader-0.55.1-cp311-cp311-macosx_10_9_x86_64.whl.

File metadata

File hashes

Hashes for ansys_mapdl_reader-0.55.1-cp311-cp311-macosx_10_9_x86_64.whl
Algorithm Hash digest
SHA256 657d71429912e0da563b82fba950d09f7f877700d6a5af4111fb880c7a452442
MD5 5d1f0c58a828077fcf63a32d7bb9f479
BLAKE2b-256 03886890a2553d1c078e0003fd30b898a82814535aabcc25ad2f7d4892e932e1

See more details on using hashes here.

File details

Details for the file ansys_mapdl_reader-0.55.1-cp311-cp311-macosx_10_9_universal2.whl.

File metadata

File hashes

Hashes for ansys_mapdl_reader-0.55.1-cp311-cp311-macosx_10_9_universal2.whl
Algorithm Hash digest
SHA256 2fdd8a917bd838a7fdf66b12cd95d86f6ec22cdc5a1e837655c0c0f52f06cd6d
MD5 1d97f0a6fceec2023e0bc3d1b2ba7350
BLAKE2b-256 68dfb25f4987443fedbfc468722e53efce95b14b00cb10a3efa49d4227a756ef

See more details on using hashes here.

File details

Details for the file ansys_mapdl_reader-0.55.1-cp310-cp310-win_amd64.whl.

File metadata

File hashes

Hashes for ansys_mapdl_reader-0.55.1-cp310-cp310-win_amd64.whl
Algorithm Hash digest
SHA256 84797018f008f67ca1b158a1eb2a8384ba528d277deef54cfe84d6d404a1377c
MD5 e7186a06e788b74a94e60d11d6ccc9c8
BLAKE2b-256 a1d554122d52dd8de2a4fc20b529207bbfc9b08250a1fe34c4f408af51deec80

See more details on using hashes here.

File details

Details for the file ansys_mapdl_reader-0.55.1-cp310-cp310-manylinux_2_17_x86_64.manylinux2014_x86_64.whl.

File metadata

File hashes

Hashes for ansys_mapdl_reader-0.55.1-cp310-cp310-manylinux_2_17_x86_64.manylinux2014_x86_64.whl
Algorithm Hash digest
SHA256 d8f56fddd4bdc5f950249bf7203764b04842b8382d6ded1f2f3e85c0f4dd83d6
MD5 19ea682017eb421b76402fe7198820aa
BLAKE2b-256 8f6003ec7dbde197dea8977f4d17562f1bbda2c035935d81fa0556f9f265a531

See more details on using hashes here.

File details

Details for the file ansys_mapdl_reader-0.55.1-cp310-cp310-macosx_10_9_x86_64.whl.

File metadata

File hashes

Hashes for ansys_mapdl_reader-0.55.1-cp310-cp310-macosx_10_9_x86_64.whl
Algorithm Hash digest
SHA256 3472ea25db57f1ed7cd43e2441f85df0700ce07fd29cc14789c5575530011a7b
MD5 56b3776a60e58769eb1c9b4a7610d8e2
BLAKE2b-256 b20a5297c940f73f32e9fa5492bf0e892ccb88b6d039b682d21598823fd3573f

See more details on using hashes here.

File details

Details for the file ansys_mapdl_reader-0.55.1-cp310-cp310-macosx_10_9_universal2.whl.

File metadata

File hashes

Hashes for ansys_mapdl_reader-0.55.1-cp310-cp310-macosx_10_9_universal2.whl
Algorithm Hash digest
SHA256 4d7c56bf3cfb92eee1d9d692fbb3817c0c94119c143d43e45cd9b27ec18ba8f1
MD5 55e4d7ed9f2a8b6e7274e85e010a3d60
BLAKE2b-256 dac29f501817e7a16d18e31e7ddfa6ca37af35f2d7ec03645236bbf47ec22089

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