Metadata-Version: 2.1
Name: yt-idefix
Version: 0.11.1
Summary: An extension module for yt, adding a frontend for Idefix
Home-page: https://github.com/yt-project/yt
Author: C.M.T. Robert
License: GPL-3.0
Project-URL: Homepage, https://yt-project.org/
Project-URL: Documentation, https://yt-project.org/docs/dev/
Project-URL: Source, https://github.com/neutrinoceros/yt_idefix
Project-URL: Tracker, https://github.com/neutrinoceros/yt_idefix/issues
Description: 
        # yt_idefix
        [![PyPI](https://img.shields.io/pypi/v/yt-idefix.svg?logo=pypi&logoColor=white&label=PyPI)](https://pypi.org/project/yt_idefix/)
        [![PyPI](https://img.shields.io/pypi/pyversions/yt-idefix/0.11.0?logo=python&logoColor=white&label=Python)](https://pypi.org/project/yt_idefix/)
        [![yt-project](https://img.shields.io/static/v1?label="works%20with"&message="yt"&color="blueviolet")](https://yt-project.org)
        
        <!--- Tests and style --->
        [![CI](https://github.com/neutrinoceros/yt_idefix/actions/workflows/ci.yml/badge.svg)](https://github.com/neutrinoceros/yt_idefix/actions/workflows/ci.yml)
        [![pre-commit.ci status](https://results.pre-commit.ci/badge/github/neutrinoceros/yt_idefix/main.svg)](https://results.pre-commit.ci/latest/github/neutrinoceros/yt_idefix/main)
        [![Code style: black](https://img.shields.io/badge/code%20style-black-000000.svg)](https://github.com/psf/black)
        [![Imports: isort](https://img.shields.io/badge/%20imports-isort-%231674b1?style=flat&labelColor=ef8336)](https://pycqa.github.io/isort/)
        
        A maturing yt frontend for Idefix and Pluto (vtk), packaged as an extension for yt.
        This frontend is a candidate for integration in the core yt code base.
        
        ## Installation
        
        ```shell
        pip install yt_idefix
        ```
        ## Usage
        
        After importing `yt` itself, make sure to activate the extension
        ```python
        import yt
        import yt_idefix
        ```
        
        Now `yt.load` will be able to read Pluto/Idefix `.vtk` output files, as well as Idefix `.dmp` dump files.
        
        
        ### Strecthed grids support
        
        yt_idefix ships a specialized loader function for datasets with streched grids
        `yt_idefix.load_stretched`. This function is experimental. Here are its known
        limitations.
        - no field magic (no aliasing, or dimensionalization, or automatic derived field generation)
        - no lazy loading (all data has to reside in memory)
        - projections are not supported
        - only supports vtk outputs (not dumps)
        
Keywords: astronomy astrophysics visualization amr adaptivemeshrefinement
Platform: UNKNOWN
Classifier: Development Status :: 2 - Pre-Alpha
Classifier: Environment :: Console
Classifier: Framework :: Matplotlib
Classifier: Intended Audience :: Science/Research
Classifier: License :: OSI Approved :: GNU General Public License v3 (GPLv3)
Classifier: Operating System :: MacOS :: MacOS X
Classifier: Operating System :: POSIX :: AIX
Classifier: Operating System :: POSIX :: Linux
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3 :: Only
Classifier: Programming Language :: Python :: 3.8
Classifier: Programming Language :: Python :: 3.9
Classifier: Programming Language :: Python :: 3.10
Classifier: Topic :: Scientific/Engineering :: Astronomy
Classifier: Topic :: Scientific/Engineering :: Physics
Classifier: Topic :: Scientific/Engineering :: Visualization
Classifier: Typing :: Typed
Requires-Python: >=3.8
Description-Content-Type: text/markdown
Provides-Extra: typecheck
