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

Uploaded Source

Built Distribution

yt_idefix-0.6.9-py3-none-any.whl (27.4 kB view details)

Uploaded Python 3

File details

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

File metadata

  • Download URL: yt_idefix-0.6.9.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.9.tar.gz
Algorithm Hash digest
SHA256 01f878b7a275a207d66bf23af8664c05fdfe52e19042d85df0f82a047b354efa
MD5 cb879a0fb1703a803c4297dd15684caf
BLAKE2b-256 c1bb931d3941829476b6d06188d6d2df4ab606f48b2d17839173825661ad56ee

See more details on using hashes here.

Provenance

File details

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

File metadata

  • Download URL: yt_idefix-0.6.9-py3-none-any.whl
  • Upload date:
  • Size: 27.4 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.9-py3-none-any.whl
Algorithm Hash digest
SHA256 e2621ae65772252d313542ea66c3f6a8ecfe4c36e6560877909b351764f2cb7d
MD5 dee490ab4feede0a02dd61ac91a14b03
BLAKE2b-256 d53dc764bcbc82d2c491e9df265ec7a009902c04a5743e7c0808d6a1a388dcb8

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