Skip to main content

An extension module for yt, adding a frontend for Idefix

Project description

yt_idefix

PyPI Supported Python Versions yt-project

pre-commit.ci status Code style: black Imports: isort

A maturing yt frontend for Idefix, packaged as an extension for yt. This frontend is a candidate for integration in the core yt code base.

Installation

Make sure you have Python 3.7 or newer, then run

python3 -m pip install yt_idefix

If you don't already have yt it will be installed along.

Usage

After importing yt itself, make sure to activate the extension

import yt
import yt.extensions.idefix

Single dump files as well as time series can be loaded directly with yt.load, e.g.,

ds = yt.load("dump.0054.dmp")
ts = yt.load("dump.00??.dmp")

But vtk files currently require a little additional work

# load a single dataset
from yt_idefix.api import IdefixVtkDataset

ds = IdefixVtkDataset("data.0042.vtk")

# load time series
class IdefixVtkDatasetSeries(yt.DatasetSeries):
    _dataset_cls = IdefixVtkDataset


ts = IdefixVtkDatasetSeries("data.00??.vtk")

This is because of a bug that will be fixed in yt's next release, see after.

Current limitations

As of version 0.5.0 of this project, I/O performances are yet to be optimized for both dump and vtk files.

Vtk support is limited to cartesian geometries and currently slightly hacky. It will received better care in upcoming releases.

As of yt 4.0.1:

  • Non-uniform grids (using log spacing) are not supported, which makes this frontend of very limited use for Idefix.
  • yt.load() is not suitable for vtk files because they are considered ambiguous since all vtk files are (erroneously) recognized as Athena. This bug is resolved on yt's dev branch (https://github.com/yt-project/yt/pull/3424)

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

yt_idefix-0.6.1.tar.gz (26.2 kB view details)

Uploaded Source

Built Distribution

yt_idefix-0.6.1-py3-none-any.whl (26.9 kB view details)

Uploaded Python 3

File details

Details for the file yt_idefix-0.6.1.tar.gz.

File metadata

  • Download URL: yt_idefix-0.6.1.tar.gz
  • Upload date:
  • Size: 26.2 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/3.4.2 importlib_metadata/4.8.1 pkginfo/1.7.1 requests/2.26.0 requests-toolbelt/0.9.1 tqdm/4.62.3 CPython/3.9.7

File hashes

Hashes for yt_idefix-0.6.1.tar.gz
Algorithm Hash digest
SHA256 97f6bd7e4848d3ca80107def7104ec9ea9d1e15fd7f823e786dcb8d6bac9361b
MD5 4d15e8518f0bb0c6398425dada044c50
BLAKE2b-256 73e5ed222e5007f8235fb3c9be51b567dd379e3701bd71f58103ddb0992b05ab

See more details on using hashes here.

Provenance

File details

Details for the file yt_idefix-0.6.1-py3-none-any.whl.

File metadata

  • Download URL: yt_idefix-0.6.1-py3-none-any.whl
  • Upload date:
  • Size: 26.9 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/3.4.2 importlib_metadata/4.8.1 pkginfo/1.7.1 requests/2.26.0 requests-toolbelt/0.9.1 tqdm/4.62.3 CPython/3.9.7

File hashes

Hashes for yt_idefix-0.6.1-py3-none-any.whl
Algorithm Hash digest
SHA256 b185c3f97582b820c59e32d00a0d76f2b352f1d816e1a5905e92f07d1cbfe00b
MD5 36ade080ea270eaf1dd6fea3702966fb
BLAKE2b-256 e60b94c7eea51494b159f60a41022e395e043e1787bf69454a63015ec10f5022

See more details on using hashes here.

Provenance

Supported by

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