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

Uploaded Source

Built Distribution

yt_idefix-0.5.0-py3-none-any.whl (26.3 kB view details)

Uploaded Python 3

File details

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

File metadata

  • Download URL: yt_idefix-0.5.0.tar.gz
  • Upload date:
  • Size: 25.7 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.5.0.tar.gz
Algorithm Hash digest
SHA256 8fdd9be56a4f59e934e29b148d9cae14c6fff1b09ae3f572f69645adba2fa89e
MD5 8c2080030c967e250c1257981cd01b49
BLAKE2b-256 4704a00f3b5c261edcb7a0f360c693d3718d61172bef9489819d6817fe7f38c4

See more details on using hashes here.

Provenance

File details

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

File metadata

  • Download URL: yt_idefix-0.5.0-py3-none-any.whl
  • Upload date:
  • Size: 26.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.5.0-py3-none-any.whl
Algorithm Hash digest
SHA256 8f41eb4d99a417480a49f3b983ae52b46929065223d2bb1b3b674d38790caf92
MD5 444625de2a8303e2f4fd9d3caf43bbe0
BLAKE2b-256 6cf944433a3627f60e61226036ffe269fc524b61f8ba21e6a3a0c830b7bb664f

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