Skip to main content

I/O for various mesh formats

Project description

meshio

I/O for mesh files.

CircleCI codecov Code style: black PyPi Version Anaconda Cloud Debian CI DOI GitHub stars PyPi downloads

There are various mesh formats available for representing unstructured meshes. meshio can read and write all of the following and smoothly converts between them:

Install with

pip3 install meshio[all] --user

and simply call

meshio-convert input.msh output.vtu

with any of the supported formats.

In Python, simply do

import meshio

mesh = meshio.read(
    filename,  # string, os.PathLike, or a buffer/open file
    file_format="stl"  # optional if filename is a path; inferred from extension
)
# mesh.points, mesh.cells, ...

# mesh.vtk.read() is also possible

to read a mesh. To write, do

points = numpy.array([
    [0.0, 0.0, 0.0],
    [0.0, 1.0, 0.0],
    [0.0, 0.0, 1.0],
    ])
cells = {
    "triangle": numpy.array([
        [0, 1, 2]
        ])
    }
meshio.write_points_cells(
    "foo.vtk",
    points,
    cells,
    # Optionally provide extra data on points, cells, etc.
    # point_data=point_data,
    # cell_data=cell_data,
    # field_data=field_data
    )

or explicitly create a mesh object for writing

mesh = meshio.Mesh(points, cells)
meshio.write(
    "foo.vtk",  # str, os.PathLike, or buffer/ open file
    mesh,
    # file_format="vtk",  # optional if first argument is a path; inferred from extension
)

# mesh.vtk.write() is also possible

For both input and output, you can optionally specify the exact file_format (in case you would like to enforce ASCII over binary VTK, for example).

Reading and writing can also be handled directly by the Mesh object:

m = meshio.Mesh.read(filename, "vtk")  # same arguments as meshio.read
m.write("foo.vtk")  # same arguments as meshio.write, besides `mesh`

Time series

The XDMF format supports time series with a shared mesh. You can write times series data using meshio with

with meshio.xdmf.TimeSeriesWriter(filename) as writer:
    writer.write_points_cells(points, cells)
    for t in [0.0, 0.1, 0.21]:
        writer.write_data(t, point_data={"phi": data})

and read it with

with meshio.xdmf.TimeSeriesReader(filename) as reader:
    points, cells = reader.read_points_cells()
    for k in range(reader.num_steps):
        t, point_data, cell_data = reader.read_data(k)

Performance comparison

performance

Some mesh formats are more suitable for I/O than others. Here you find an overview of how fast the meshio routines are for a certain mesh with about 100k nodes.

File size comparison

file size

Comparison of the file sizes for a tetrahedral mesh with about 100k points. The red line marks the size of the mesh in memory.

Installation

meshio is available from the Python Package Index, so simply do

pip3 install meshio --user

to install.

Additional dependencies (netcdf4, h5py and lxml) are required for some of the output formats and can be pulled in by

pip install meshio[all] --user

You can also install meshio from anaconda:

conda install -c conda-forge meshio

Testing

To run the meshio unit tests, check out this repository and type

pytest

License

meshio is published under the MIT license.

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

meshio-3.3.0.tar.gz (167.8 kB view details)

Uploaded Source

Built Distribution

meshio-3.3.0-py3-none-any.whl (102.9 kB view details)

Uploaded Python 3

File details

Details for the file meshio-3.3.0.tar.gz.

File metadata

  • Download URL: meshio-3.3.0.tar.gz
  • Upload date:
  • Size: 167.8 kB
  • Tags: Source
  • 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.2 CPython/3.7.5

File hashes

Hashes for meshio-3.3.0.tar.gz
Algorithm Hash digest
SHA256 47f238cc97b8db89b38d6a67a35357d8a322c7d8adef1c0c82111fbc5dd236c6
MD5 2ade712c47a792e92be784ad53dc39a8
BLAKE2b-256 422226c5774d2fdf108461579b4351a122d80b32c1dc42df57bac53e01d843e9

See more details on using hashes here.

File details

Details for the file meshio-3.3.0-py3-none-any.whl.

File metadata

  • Download URL: meshio-3.3.0-py3-none-any.whl
  • Upload date:
  • Size: 102.9 kB
  • Tags: Python 3
  • 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.2 CPython/3.7.5

File hashes

Hashes for meshio-3.3.0-py3-none-any.whl
Algorithm Hash digest
SHA256 02cfc6465eb8273430856b47105ffeff1ac721055f92b1da854bd1b53f5809d1
MD5 6450be62f3e9011d36fc845274dfa245
BLAKE2b-256 705926339bd2d6b02e33c3703086cb5b6c11055afa5cb0002f8172a682ff0ca2

See more details on using hashes here.

Supported by

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