Skip to main content
https://badge.fury.io/py/IFEM-to-VT.svg https://travis-ci.org/TheBB/IFEM-to-VT.svg?branch=master

IFEM-to-VT is a tool for converting between various data formats used for storing simulation results.

Supported readers:

  • IFEM HDF5 files (.hdf5)

  • LRSpline geometries (.lr)

  • GoTools (B-Spline) geometries (.g2)

  • SIMRA result files (.res)

  • WRF result files (NetCDF4)

Supported writers:

The tool is so named because it was initially designed for IFEM, and only for output formats that started with “VT”.

Installation

It is recommended to install with PIP:

pip install --user IFEM-to-VT

To install from source:

pip install --user .

IFEM-to-VT requires Python 3. It is possible that, on your system, pip refers to Python 2. In this case, do:

pip3 install --user IFEM-to-VT

or:

pip3 install --user .

IFEM-to-VT requires the numpy, H5Py, VTK and LRSplines libraries, all of which contain compiled components. In ideal circumstances, they should be installed automatically from PyPi with the above commands, but circumstances are not always ideal. For example, VTK is, as of the time of writing, not available for Python 3.8 on PyPi. If dependencies fail to install, please consult the relevant documentation of the respective libraries.

VTF support is not available out-of-the-box because it depends on proprietary libaries. If these libraries are available on your system, you may install VTFWriter manually. If it is present, IFEM-to-VT should enable VTF support automatically.

Upon successful installation, an ifem-to-vt executable should be installed in ~/.local/bin, or the binary path of the current Python environment. To run it, ensure that this directory is in your PATH.

Usage

Basic usage is:

ifem-to-vt INFILE.hdf5 [OUTFILE]

For help with relevant command-line-options please consult:

ifem-to-vt --help

If the output filename is specified, the format will be determined from its extension, unless specifically overriden with -f or --fmt:

ifem-to-vt -f vtu INFILE.hdf5

Some options are only available for certain input or output formats, and for some options some specific values may only be available for certain input or output formats. Further, depending on circumstances, some options may be determined to be incompatible with each other. In all these cases you should be either warned or provided with an error message. If you feel you get an error in a case where that shouldn’t happen, please open an issue, including the information from running with --debug.

Logging options

The verbosity of standard output can be changed with --debug (use for bug reports), --info (default), --user, --warning and --error.

IFEM-to-VT will try to use rich formatted output by default. Switch this off with --no-rich.

General options

To increase resolution beyond linear interpolation between element vertices, use the -n or --nvis option. A value of e.g. 3 indicates that each element should be subdivided into three per axis, creating a 9-fold increase in data amount for 2D results.

To include only certain fields use the --filter or -l option. Issue this option multiple times, or give a comma-separated list as argument.

Use -f or --fmt to override the output format, which is by default derived from the output filename extension. This may be necessary for formats which write to directories.

Use --last to only write the final timestep.

Use --mode to specify output mode, depending on what the writer is capable of. All current writers are capable of switching between binary (default) and ascii mode.

WRF options

Output is given in projected coordinates by default. If --global is given, they will be converted to true physical coordinates, with the origin at the center of the Earth, the x-axis pointing toward the prime meridian and the z-axis pointing toward the north pole.

By default, the output is a 3D mesh including all volumetric fields. If --planar is given, it will be a 2D mesh including only planar fields, as well as the surface slice of volumetric fields. If --extrude is given, it will be a 3D mesh including all volumetric fields, as well as planar fields interpreted as constants in the vertical direction.

If --periodic is given, IFEM-to-VT will interpret the mesh as a global grid and attempt to tie it together in the longitudinal axis and at the poles. This only works together with --global.

IFEM options

The output may be restricted to certain bases with --basis or -b. Use this option multiple times or give a comma-separated list as argument.

The basis for the geometry can be chosen with --geometry.

SIMRA options

The endianness of the input can be specified with --endianness, with valid arguments being native (default), little and big.

Release files for IFEM-to-VT 2.0.2

For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.

Source distribution (sdist)

Source distribution for IFEM-to-VT 2.0.2
File Size Uploaded
IFEM-to-VT-2.0.2.tar.gz 31.5 kB Details

Built distribution (wheel)

Table of built distributions (wheels) for IFEM-to-VT 2.0.2
File Interpreter ABI Platform
IFEM_to_VT-2.0.2-py3-none-any.whl Python 3 none any Details

Total release size: 81.2 kB

Release files / IFEM-to-VT-2.0.2.tar.gz

Download URL IFEM-to-VT-2.0.2.tar.gz
Size 31.5 kB
Tags Source
SHA-256 checksum
How to use checksums
d9dd6b56d7cebcb82f5bd838bac14b0b3d0085bea520e445e2402489fead4fb7
BLAKE2b-256 checksum
How to use checksums
2ce6a0a8dacc0dc6f38c85284fe30e8a57657729a16a5ea5e4b648adead8baa0
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via twine/3.2.0 pkginfo/1.5.0.1 requests/2.24.0 setuptools/49.6.0.post20200814 requests-toolbelt/0.9.1 tqdm/4.48.2 CPython/3.6.10

Release files / IFEM_to_VT-2.0.2-py3-none-any.whl

Download URL IFEM_to_VT-2.0.2-py3-none-any.whl
Size 49.7 kB
Tags Python 3
SHA-256 checksum
How to use checksums
3ac57bf109ded3f17f91ea30902e7119d98dda0f395b047d6e0c2ca54c0abb11
BLAKE2b-256 checksum
How to use checksums
f289057d1024a7465447373a3b858dffdcc34f67fd7fd85943f8e3dd01210811
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via twine/3.2.0 pkginfo/1.5.0.1 requests/2.24.0 setuptools/49.6.0.post20200814 requests-toolbelt/0.9.1 tqdm/4.48.2 CPython/3.6.10

Release history Release notifications | RSS feed

This release

2.0.2 This release

2 release files

1.1.0

2 release files

1.0.3

2 release files

1.0.0

2 release files

Anthropic, PBC Visionary sponsor Bloomberg Visionary sponsor Hudson River Trading Visionary sponsor Meta Visionary sponsor NVIDIA Visionary sponsor Microsoft Sustainability sponsor Depot Continuous Integration AWS Cloud computing and Security Sponsor Datadog Monitoring Fastly CDN Google Download Analytics Sentry Error logging StatusPage Status page