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

The comparisons here are for a tetrahedral mesh with about 400k points and 2M tetrahedra. The red lines mark the size of the mesh in memory.

File sizes

file size

I/O speed

performance

Maximum memory usage

memory usage

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.1.tar.gz (86.8 kB view details)

Uploaded Source

Built Distribution

meshio-3.3.1-py3-none-any.whl (106.9 kB view details)

Uploaded Python 3

File details

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

File metadata

  • Download URL: meshio-3.3.1.tar.gz
  • Upload date:
  • Size: 86.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.1.tar.gz
Algorithm Hash digest
SHA256 c00371adfda84efd5557f400159aab4baaacb6abd374aac1ba2cf2d8fddc1862
MD5 ef16b823449f74cac191ee234e39b34b
BLAKE2b-256 0b00738f6d4b03a65ae5864f239bdbbc0e2cfa99b1ecb36dc3c82b2593e96f0d

See more details on using hashes here.

File details

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

File metadata

  • Download URL: meshio-3.3.1-py3-none-any.whl
  • Upload date:
  • Size: 106.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.1-py3-none-any.whl
Algorithm Hash digest
SHA256 237305cabb1c8d72f4c4673ccf8bfd88f5495c04899fe57623339a386de3ad2f
MD5 cec697842b752cf0f5427b28ef334c7b
BLAKE2b-256 9f07cf58a295a06f4b672bfa9b87e7f34fc003d39f7e0f4fa6ae495f631d71dd

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