Skip to main content

An extension module for yt, adding a frontend for Idefix

Project description

yt_idefix

PyPI PyPI yt-project

CI 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.

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

Uploaded Source

Built Distribution

yt_idefix-0.6.8-py3-none-any.whl (27.3 kB view details)

Uploaded Python 3

File details

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

File metadata

  • Download URL: yt_idefix-0.6.8.tar.gz
  • Upload date:
  • Size: 26.6 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.8.tar.gz
Algorithm Hash digest
SHA256 c416b6dea6e0eeb46b173e6aee92cc57c907f9582b7b70ec5a71be3913a1b61a
MD5 332ee825796fcee8c16a36dc0fe3c016
BLAKE2b-256 df8a79aba1b848b4b79b280ffbcf883599a4bf9647145231400650a7abaf53c4

See more details on using hashes here.

File details

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

File metadata

  • Download URL: yt_idefix-0.6.8-py3-none-any.whl
  • Upload date:
  • Size: 27.3 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.8-py3-none-any.whl
Algorithm Hash digest
SHA256 2ffb8aa6ecd98da420bacc229ada5ea18860a18677a3e9ce3be286d3c17495bb
MD5 0ef6f80450d26e81acff70bea693d94b
BLAKE2b-256 dec5188c30d58894e98974e55c08190e7f5c7d3e91dfc4e1ff8afafa031c4beb

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 Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page