%global _empty_manifest_terminate_build 0
Name: python-yt-idefix
Version: 2.2.0
Release: 1
Summary: An extension module for yt, adding a frontend for Idefix and Pluto
License: GPL-3.0
URL: https://yt-project.org/
Source0: https://mirrors.aliyun.com/pypi/web/packages/a4/4f/b35e0b74bf50240df0ab6e1af4d022485d8ed52512323f2a7a402549798f/yt_idefix-2.2.0.tar.gz
BuildArch: noarch
Requires: python3-inifix
Requires: python3-numpy
Requires: python3-yt
Requires: python3-h5py
%description
# yt_idefix
[](https://pypi.org/project/yt_idefix/)
[](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 --->
[](https://github.com/neutrinoceros/yt_idefix/actions/workflows/ci.yml)
[](https://results.pre-commit.ci/latest/github/neutrinoceros/yt_idefix/main)
[](https://github.com/psf/black)
[](https://github.com/charliermarsh/ruff)
A maturing yt frontend for Idefix and Pluto, packaged as an extension for yt.
## Installation
```shell
python -m pip install yt_idefix
```
## Supported formats
| Code | format | supported since | additional dependencies |
|--------|:------:|:---------------:|-------------------------|
| Idefix | `.dmp` | v0.1.0 | |
| Idefix | `.vtk` | v0.3.0 | |
| Pluto | `.vtk` | v0.9.0 | |
| Pluto | XDMF | v1.1.0 | `h5py` |
## Usage
Integration with yt is seamless. *Installing* this plugin is all that's required to make yt
compatible with data formats supported by `yt_idefix` !
### Additional arguments to `yt.load`
The metadata are parsed from data file, definitions header file and inifile when loading dataset.
Definitions header file (`definitions.h` for Pluto, or `definitions.hpp` for Idefix) and inifile (`pluto.ini` and `idefix.ini` respectively) are discovered automatically if they match default names, are located along with data files, and unique. Otherwise, they can be specified explicitly as paths (either relative to data files or absolute paths) with parameters `definitions_header` and `inifile` respectively.
Geometry is parsed automatically whenever possible, but as a last resort, it can also be specified as a keyword argument (possible values are "cartesian", "spherical", "cylindrical" and "polar").
```python
# Examples
ds = yt.load("data.0010.vtk", definitions_header="../definitions.h", inifile="example.ini")
ds = yt.load("data.0010.vtk", geometry='spherical")
```
The data are loaded as physical quantities with units. The default unit system is `cgs` in yt. This frontend can convert data from code units into `cgs` properly, based on the unit definitions from metadata.
Users are able to choose the unit displayed in two ways, through `unit_system` ("code", "mks" and "cgs") and `units_override`(only valid for Pluto).
```python
# Examples on units
ds = yt.load("data.0010.vtk", unit_system='mks")
units_override = dict(length_unit=(100.0, "au"), mass_unit=yt.units.mass_sun)
ds = yt.load("data.0010.vtk", unit_override=unit_override) # Caution that other units will also be changed for consistency!!
```
With Pluto data, the rest of the system will be derived consistently with given units, within the following rules:
1. Temperature unit cannot be overridden (always set to Kelvin)
2. No more than three units can be overridden at once (overconstrained systems are never validated for simplicity)
3. When given less than three overrides, base units in Pluto (ordered: velocity_unit, density_unit, length_unit) are assumed
4. The following combinations are not allowed
```python
{"magnetic_unit", "velocity_unit", "density_unit"},
{"velocity_unit", "time_unit", "length_unit"},
{"density_unit", "length_unit", "mass_unit"},
```
yt is able to provide some derived fields from existed fields, e.g., `"cell_volume"`. Fields related to element species can be created according to primordial abundances of H and He, through `default_species_fields` (`"neutral"` and `"ionized"`) parameters.
```python
# Example
ds = yt.load("data.0010.vtk", default_species_fields="ionized")
```
### Convention of field names
The outputs are loaded from disk with field names in uppercase. This normalization is only applied to the standard outputs but user-defined outputs and Pluto's ion fraction outputs.
```python
# Example
ds.field_list
# Output:
# [('pluto-vtk', 'PRS'), # standard output
# ('pluto-vtk', 'RHO'), # standard output
# ('pluto-vtk', 'VX1'), # standard output
# ('pluto-vtk', 'VX2'), # standard output
# ('pluto-vtk', 'VX3'), # standard output
# ('pluto-vtk', 'temp')] # This is a user-defined output
```
%package -n python3-yt-idefix
Summary: An extension module for yt, adding a frontend for Idefix and Pluto
Provides: python-yt-idefix
BuildRequires: python3-devel
BuildRequires: python3-setuptools
BuildRequires: python3-pip
%description -n python3-yt-idefix
# yt_idefix
[](https://pypi.org/project/yt_idefix/)
[](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 --->
[](https://github.com/neutrinoceros/yt_idefix/actions/workflows/ci.yml)
[](https://results.pre-commit.ci/latest/github/neutrinoceros/yt_idefix/main)
[](https://github.com/psf/black)
[](https://github.com/charliermarsh/ruff)
A maturing yt frontend for Idefix and Pluto, packaged as an extension for yt.
## Installation
```shell
python -m pip install yt_idefix
```
## Supported formats
| Code | format | supported since | additional dependencies |
|--------|:------:|:---------------:|-------------------------|
| Idefix | `.dmp` | v0.1.0 | |
| Idefix | `.vtk` | v0.3.0 | |
| Pluto | `.vtk` | v0.9.0 | |
| Pluto | XDMF | v1.1.0 | `h5py` |
## Usage
Integration with yt is seamless. *Installing* this plugin is all that's required to make yt
compatible with data formats supported by `yt_idefix` !
### Additional arguments to `yt.load`
The metadata are parsed from data file, definitions header file and inifile when loading dataset.
Definitions header file (`definitions.h` for Pluto, or `definitions.hpp` for Idefix) and inifile (`pluto.ini` and `idefix.ini` respectively) are discovered automatically if they match default names, are located along with data files, and unique. Otherwise, they can be specified explicitly as paths (either relative to data files or absolute paths) with parameters `definitions_header` and `inifile` respectively.
Geometry is parsed automatically whenever possible, but as a last resort, it can also be specified as a keyword argument (possible values are "cartesian", "spherical", "cylindrical" and "polar").
```python
# Examples
ds = yt.load("data.0010.vtk", definitions_header="../definitions.h", inifile="example.ini")
ds = yt.load("data.0010.vtk", geometry='spherical")
```
The data are loaded as physical quantities with units. The default unit system is `cgs` in yt. This frontend can convert data from code units into `cgs` properly, based on the unit definitions from metadata.
Users are able to choose the unit displayed in two ways, through `unit_system` ("code", "mks" and "cgs") and `units_override`(only valid for Pluto).
```python
# Examples on units
ds = yt.load("data.0010.vtk", unit_system='mks")
units_override = dict(length_unit=(100.0, "au"), mass_unit=yt.units.mass_sun)
ds = yt.load("data.0010.vtk", unit_override=unit_override) # Caution that other units will also be changed for consistency!!
```
With Pluto data, the rest of the system will be derived consistently with given units, within the following rules:
1. Temperature unit cannot be overridden (always set to Kelvin)
2. No more than three units can be overridden at once (overconstrained systems are never validated for simplicity)
3. When given less than three overrides, base units in Pluto (ordered: velocity_unit, density_unit, length_unit) are assumed
4. The following combinations are not allowed
```python
{"magnetic_unit", "velocity_unit", "density_unit"},
{"velocity_unit", "time_unit", "length_unit"},
{"density_unit", "length_unit", "mass_unit"},
```
yt is able to provide some derived fields from existed fields, e.g., `"cell_volume"`. Fields related to element species can be created according to primordial abundances of H and He, through `default_species_fields` (`"neutral"` and `"ionized"`) parameters.
```python
# Example
ds = yt.load("data.0010.vtk", default_species_fields="ionized")
```
### Convention of field names
The outputs are loaded from disk with field names in uppercase. This normalization is only applied to the standard outputs but user-defined outputs and Pluto's ion fraction outputs.
```python
# Example
ds.field_list
# Output:
# [('pluto-vtk', 'PRS'), # standard output
# ('pluto-vtk', 'RHO'), # standard output
# ('pluto-vtk', 'VX1'), # standard output
# ('pluto-vtk', 'VX2'), # standard output
# ('pluto-vtk', 'VX3'), # standard output
# ('pluto-vtk', 'temp')] # This is a user-defined output
```
%package help
Summary: Development documents and examples for yt-idefix
Provides: python3-yt-idefix-doc
%description help
# yt_idefix
[](https://pypi.org/project/yt_idefix/)
[](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 --->
[](https://github.com/neutrinoceros/yt_idefix/actions/workflows/ci.yml)
[](https://results.pre-commit.ci/latest/github/neutrinoceros/yt_idefix/main)
[](https://github.com/psf/black)
[](https://github.com/charliermarsh/ruff)
A maturing yt frontend for Idefix and Pluto, packaged as an extension for yt.
## Installation
```shell
python -m pip install yt_idefix
```
## Supported formats
| Code | format | supported since | additional dependencies |
|--------|:------:|:---------------:|-------------------------|
| Idefix | `.dmp` | v0.1.0 | |
| Idefix | `.vtk` | v0.3.0 | |
| Pluto | `.vtk` | v0.9.0 | |
| Pluto | XDMF | v1.1.0 | `h5py` |
## Usage
Integration with yt is seamless. *Installing* this plugin is all that's required to make yt
compatible with data formats supported by `yt_idefix` !
### Additional arguments to `yt.load`
The metadata are parsed from data file, definitions header file and inifile when loading dataset.
Definitions header file (`definitions.h` for Pluto, or `definitions.hpp` for Idefix) and inifile (`pluto.ini` and `idefix.ini` respectively) are discovered automatically if they match default names, are located along with data files, and unique. Otherwise, they can be specified explicitly as paths (either relative to data files or absolute paths) with parameters `definitions_header` and `inifile` respectively.
Geometry is parsed automatically whenever possible, but as a last resort, it can also be specified as a keyword argument (possible values are "cartesian", "spherical", "cylindrical" and "polar").
```python
# Examples
ds = yt.load("data.0010.vtk", definitions_header="../definitions.h", inifile="example.ini")
ds = yt.load("data.0010.vtk", geometry='spherical")
```
The data are loaded as physical quantities with units. The default unit system is `cgs` in yt. This frontend can convert data from code units into `cgs` properly, based on the unit definitions from metadata.
Users are able to choose the unit displayed in two ways, through `unit_system` ("code", "mks" and "cgs") and `units_override`(only valid for Pluto).
```python
# Examples on units
ds = yt.load("data.0010.vtk", unit_system='mks")
units_override = dict(length_unit=(100.0, "au"), mass_unit=yt.units.mass_sun)
ds = yt.load("data.0010.vtk", unit_override=unit_override) # Caution that other units will also be changed for consistency!!
```
With Pluto data, the rest of the system will be derived consistently with given units, within the following rules:
1. Temperature unit cannot be overridden (always set to Kelvin)
2. No more than three units can be overridden at once (overconstrained systems are never validated for simplicity)
3. When given less than three overrides, base units in Pluto (ordered: velocity_unit, density_unit, length_unit) are assumed
4. The following combinations are not allowed
```python
{"magnetic_unit", "velocity_unit", "density_unit"},
{"velocity_unit", "time_unit", "length_unit"},
{"density_unit", "length_unit", "mass_unit"},
```
yt is able to provide some derived fields from existed fields, e.g., `"cell_volume"`. Fields related to element species can be created according to primordial abundances of H and He, through `default_species_fields` (`"neutral"` and `"ionized"`) parameters.
```python
# Example
ds = yt.load("data.0010.vtk", default_species_fields="ionized")
```
### Convention of field names
The outputs are loaded from disk with field names in uppercase. This normalization is only applied to the standard outputs but user-defined outputs and Pluto's ion fraction outputs.
```python
# Example
ds.field_list
# Output:
# [('pluto-vtk', 'PRS'), # standard output
# ('pluto-vtk', 'RHO'), # standard output
# ('pluto-vtk', 'VX1'), # standard output
# ('pluto-vtk', 'VX2'), # standard output
# ('pluto-vtk', 'VX3'), # standard output
# ('pluto-vtk', 'temp')] # This is a user-defined output
```
%prep
%autosetup -n yt_idefix-2.2.0
%build
%py3_build
%install
%py3_install
install -d -m755 %{buildroot}/%{_pkgdocdir}
if [ -d doc ]; then cp -arf doc %{buildroot}/%{_pkgdocdir}; fi
if [ -d docs ]; then cp -arf docs %{buildroot}/%{_pkgdocdir}; fi
if [ -d example ]; then cp -arf example %{buildroot}/%{_pkgdocdir}; fi
if [ -d examples ]; then cp -arf examples %{buildroot}/%{_pkgdocdir}; fi
pushd %{buildroot}
if [ -d usr/lib ]; then
find usr/lib -type f -printf "\"/%h/%f\"\n" >> filelist.lst
fi
if [ -d usr/lib64 ]; then
find usr/lib64 -type f -printf "\"/%h/%f\"\n" >> filelist.lst
fi
if [ -d usr/bin ]; then
find usr/bin -type f -printf "\"/%h/%f\"\n" >> filelist.lst
fi
if [ -d usr/sbin ]; then
find usr/sbin -type f -printf "\"/%h/%f\"\n" >> filelist.lst
fi
touch doclist.lst
if [ -d usr/share/man ]; then
find usr/share/man -type f -printf "\"/%h/%f.gz\"\n" >> doclist.lst
fi
popd
mv %{buildroot}/filelist.lst .
mv %{buildroot}/doclist.lst .
%files -n python3-yt-idefix -f filelist.lst
%dir %{python3_sitelib}/*
%files help -f doclist.lst
%{_docdir}/*
%changelog
* Fri Jun 09 2023 Python_Bot <Python_Bot@openeuler.org> - 2.2.0-1
- Package Spec generated