yt.frontends.ramses.data_structures module

class yt.frontends.ramses.data_structures.RAMSESDataset(filename=None, *args, **kwargs)[source]

Bases: yt.data_objects.static_output.Dataset

add_deposited_particle_field(deposit_field, method, kernel_name='cubic', weight_field=None)

Add a new deposited particle field

Creates a new deposited field based on the particle deposit_field.

Parameters
  • deposit_field (tuple) – The field name tuple of the particle field the deposited field will be created from. This must be a field name tuple so yt can appropriately infer the correct particle type.

  • method (string) – This is the “method name” which will be looked up in the particle_deposit namespace as methodname_deposit. Current methods include simple_smooth, sum, std, cic, weighted_mean, nearest and count.

  • kernel_name (string, default 'cubic') – This is the name of the smoothing kernel to use. It is only used for the simple_smooth method and is otherwise ignored. Current supported kernel names include cubic, quartic, quintic, wendland2, wendland4, and wendland6.

  • weight_field ((field_type, field_name) or None) – Weighting field name for deposition method weighted_mean. If None, use the particle mass.

Returns

Return type

The field name tuple for the newly created field.

add_field(name, function, sampling_type, **kwargs)

Dataset-specific call to add_field

Add a new field, along with supplemental metadata, to the list of available fields. This respects a number of arguments, all of which are passed on to the constructor for DerivedField.

Parameters
  • name (str) – is the name of the field.

  • function (callable) – A function handle that defines the field. Should accept arguments (field, data)

  • sampling_type (str) – “cell” or “particle” or “local”

  • units (str) – A plain text string encoding the unit. Powers must be in python syntax (** instead of ^).

  • take_log (bool) – Describes whether the field should be logged

  • validators (list) – A list of FieldValidator objects

  • vector_field (bool) – Describes the dimensionality of the field. Currently unused.

  • display_name (str) – A name used in the plots

  • force_override (bool) – Whether to override an existing derived field. Does not work with on-disk fields.

add_gradient_fields(fields=None, input_field=None)

Add gradient fields.

Creates four new grid-based fields that represent the components of the gradient of an existing field, plus an extra field for the magnitude of the gradient. The gradient is computed using second-order centered differences.

Parameters

fields (str or tuple(str, str), or a list of the previous) – Label(s) for at least one field. Can either represent a tuple (<field type>, <field fname>) or simply the field name. Warning: several field types may match the provided field name, in which case the first one discovered internally is used.

Returns

Return type

A list of field name tuples for the newly created fields.

Raises
  • YTFieldNotParsable – If fields are not parsable to yt field keys.

  • YTFieldNotFound : – If at least one field can not be identified.

Examples

>>> grad_fields = ds.add_gradient_fields(("gas", "density"))
>>> print(grad_fields)
... [
...     ("gas", "density_gradient_x"),
...     ("gas", "density_gradient_y"),
...     ("gas", "density_gradient_z"),
...     ("gas", "density_gradient_magnitude"),
... ]

Note that the above example assumes ds.geometry == ‘cartesian’. In general, the function will create gradient components along the axes of the dataset coordinate system. For instance, with cylindrical data, one gets ‘density_gradient_<r,theta,z>’

add_mesh_sampling_particle_field(sample_field, ptype='all')

Add a new mesh sampling particle field

Creates a new particle field which has the value of the deposit_field at the location of each particle of type ptype.

Parameters
  • sample_field (tuple) – The field name tuple of the mesh field to be deposited onto the particles. This must be a field name tuple so yt can appropriately infer the correct particle type.

  • ptype (string, default 'all') – The particle type onto which the deposition will occur.

Returns

Return type

The field name tuple for the newly created field.

Examples

>>> ds = yt.load("output_00080/info_00080.txt")
... ds.add_mesh_sampling_particle_field(("gas", "density"), ptype="all")
>>> print("The density at the location of the particle is:")
... print(ds.r["all", "cell_gas_density"])
The density at the location of the particle is:
[9.33886124e-30 1.22174333e-28 1.20402333e-28 ... 2.77410331e-30
 8.79467609e-31 3.50665136e-30] g/cm**3
>>> len(ds.r["all", "cell_gas_density"]) == len(ds.r["all", "particle_ones"])
True
add_particle_filter(filter)

Add particle filter to the dataset.

Add filter to the dataset and set up relavent derived_field. It will also add any filtered_type that the filter depends on.

add_particle_union(union)
add_smoothed_particle_field(smooth_field, method='volume_weighted', nneighbors=64, kernel_name='cubic')

Add a new smoothed particle field

WARNING: This method is deprecated since yt-4.0.

Creates a new smoothed field based on the particle smooth_field.

Parameters
  • smooth_field (tuple) – The field name tuple of the particle field the smoothed field will be created from. This must be a field name tuple so yt can appropriately infer the correct particle type.

  • method (string, default 'volume_weighted') – The particle smoothing method to use. Can only be ‘volume_weighted’ for now.

  • nneighbors (int, default 64) – The number of neighbors to examine during the process.

  • kernel_name (string, default cubic) – This is the name of the smoothing kernel to use. Current supported kernel names include cubic, quartic, quintic, wendland2, wendland4, and wendland6.

Returns

Return type

The field name tuple for the newly created field.

all_data(find_max=False, **kwargs)

all_data is a wrapper to the Region object for creating a region which covers the entire simulation domain.

property arr

Converts an array into a yt.units.yt_array.YTArray

The returned YTArray will be dimensionless by default, but can be cast to arbitrary units using the units keyword argument.

Parameters
  • input_array (Iterable) – A tuple, list, or array to attach units to

  • units (String unit specification, unit symbol or astropy object) – The units of the array. Powers must be specified using python syntax (cm**3, not cm^3).

  • input_units (Deprecated in favor of 'units') –

  • dtype (string or NumPy dtype object) – The dtype of the returned array data

Examples

>>> import yt
>>> import numpy as np
>>> ds = yt.load("IsolatedGalaxy/galaxy0030/galaxy0030")
>>> a = ds.arr([1, 2, 3], "cm")
>>> b = ds.arr([4, 5, 6], "m")
>>> a + b
YTArray([ 401.,  502.,  603.]) cm
>>> b + a
YTArray([ 4.01,  5.02,  6.03]) m

Arrays returned by this function know about the dataset’s unit system

>>> a = ds.arr(np.ones(5), "code_length")
>>> a.in_units("Mpccm/h")
YTArray([ 1.00010449,  1.00010449,  1.00010449,  1.00010449,
         1.00010449]) Mpc
box(left_edge, right_edge, **kwargs)

box is a wrapper to the Region object for creating a region without having to specify a center value. It assumes the center is the midpoint between the left_edge and right_edge.

Keyword arguments are passed to the initializer of the YTRegion object (e.g. ds.region).

property checksum

Computes md5 sum of a dataset.

Note: Currently this property is unable to determine a complete set of files that are a part of a given dataset. As a first approximation, the checksum of parameter_file is calculated. In case parameter_file is a directory, checksum of all files inside the directory is calculated.

close()
coordinates = None
create_field_info(*args, **kwa)[source]

Extend create_field_info to add the particles types.

default_field = ('gas', 'density')
default_fluid_type = 'gas'
default_units = {'length_unit': 'cm', 'magnetic_unit': 'gauss', 'mass_unit': 'g', 'temperature_unit': 'K', 'time_unit': 's', 'velocity_unit': 'cm/s'}
define_unit(symbol, value, tex_repr=None, offset=None, prefixable=False)

Define a new unit and add it to the dataset’s unit registry.

Parameters
  • symbol (string) – The symbol for the new unit.

  • value (tuple or YTQuantity) – The definition of the new unit in terms of some other units. For example, one would define a new “mph” unit with (1.0, “mile/hr”)

  • tex_repr (string, optional) – The LaTeX representation of the new unit. If one is not supplied, it will be generated automatically based on the symbol string.

  • offset (float, optional) – The default offset for the unit. If not set, an offset of 0 is assumed.

  • prefixable (bool, optional) – Whether or not the new unit can use SI prefixes. Default: False

Examples

>>> ds.define_unit("mph", (1.0, "mile/hr"))
>>> two_weeks = YTQuantity(14.0, "days")
>>> ds.define_unit("fortnight", two_weeks)
property derived_field_list
domain_center = None
domain_dimensions = None
domain_left_edge = None
domain_right_edge = None
domain_width = None
property field_list
field_units = None
property fields
fields_detected = False
find_field_values_at_point(fields, coords)

Returns the values [field1, field2,…] of the fields at the given coordinates. Returns a list of field values in the same order as the input fields.

find_field_values_at_points(fields, coords)

Returns the values [field1, field2,…] of the fields at the given [(x1, y1, z2), (x2, y2, z2),…] points. Returns a list of field values in the same order as the input fields.

find_max(field, source=None, to_array=True)

Returns (value, location) of the maximum of a given field.

This is a wrapper around _find_extremum

find_min(field, source=None, to_array=True)

Returns (value, location) for the minimum of a given field.

This is a wrapper around _find_extremum

fluid_types = ('gas', 'deposit', 'index')
force_periodicity(val=True)

Override box periodicity to (True, True, True). Use ds.force_periodicty(False) to use the actual box periodicity.

gamma = 1.4
geometry = 'cartesian'
get_smallest_appropriate_unit(v, quantity='distance', return_quantity=False)

Returns the largest whole unit smaller than the YTQuantity passed to it as a string.

The quantity keyword can be equal to distance or time. In the case of distance, the units are: ‘Mpc’, ‘kpc’, ‘pc’, ‘au’, ‘rsun’, ‘km’, etc. For time, the units are: ‘Myr’, ‘kyr’, ‘yr’, ‘day’, ‘hr’, ‘s’, ‘ms’, etc.

If return_quantity is set to True, it finds the largest YTQuantity object with a whole unit and a power of ten as the coefficient, and it returns this YTQuantity.

get_unit_from_registry(unit_str)

Creates a unit object matching the string expression, using this dataset’s unit registry.

Parameters

unit_str (str) – string that we can parse for a sympy Expr.

has_key(key)

Checks units, parameters, and conversion factors. Returns a boolean.

property index
property ires_factor
known_filters = None
property max_level
property min_level
property particle_fields_by_type
property particle_type_counts
particle_types = ('io',)
particle_types_raw = ('io',)
particle_unions = None
property particles_exist
property periodicity
print_key_parameters()
print_stats()
property quan

Converts an scalar into a yt.units.yt_array.YTQuantity

The returned YTQuantity will be dimensionless by default, but can be cast to arbitrary units using the units keyword argument.

Parameters
  • input_scalar (an integer or floating point scalar) – The scalar to attach units to

  • units (String unit specification, unit symbol or astropy object) – The units of the quantity. Powers must be specified using python syntax (cm**3, not cm^3).

  • input_units (Deprecated in favor of 'units') –

  • dtype (string or NumPy dtype object) – The dtype of the array data.

Examples

>>> import yt
>>> ds = yt.load("IsolatedGalaxy/galaxy0030/galaxy0030")
>>> a = ds.quan(1, "cm")
>>> b = ds.quan(2, "m")
>>> a + b
201.0 cm
>>> b + a
2.01 m

Quantities created this way automatically know about the unit system of the dataset.

>>> a = ds.quan(5, "code_length")
>>> a.in_cgs()
1.543e+25 cm
read_namelist()[source]

Read the namelist.txt file in the output folder, if present

relative_refinement(l0, l1)
set_code_units()
set_field_label_format(format_property, value)

Set format properties for how fields will be written out. Accepts

format_property : string indicating what property to set value: the value to set for that format_property

set_units()

Creates the unit registry for this dataset.

setup_cosmology()

If this dataset is cosmological, add a cosmology object.

setup_deprecated_fields()
storage_filename = None
property unique_identifier
property units
class yt.frontends.ramses.data_structures.RAMSESDomainFile(ds, domain_id)[source]

Bases: object

property amr_file
included(selector)[source]
property level_count
class yt.frontends.ramses.data_structures.RAMSESDomainSubset(base_region, domain, ds, over_refine_factor=1, num_ghost_zones=0, base_grid=None)[source]

Bases: yt.data_objects.index_subobjects.octree_subset.OctreeSubset

apply_units(arr, units)
argmax(field, axis=None)

Return the values at which the field is maximized.

This will, in a parallel-aware fashion, find the maximum value and then return to you the values at that maximum location that are requested for “axis”. By default it will return the spatial positions (in the natural coordinate system), but it can be any field

Parameters
  • field (string or tuple field name) – The field to maximize.

  • axis (string or list of strings, optional) – If supplied, the fields to sample along; if not supplied, defaults to the coordinate fields. This can be the name of the coordinate fields (i.e., ‘x’, ‘y’, ‘z’) or a list of fields, but cannot be 0, 1, 2.

Returns

Return type

A list of YTQuantities as specified by the axis argument.

Examples

>>> temp_at_max_rho = reg.argmax(
...     ("gas", "density"), axis=("gas", "temperature")
... )
>>> max_rho_xyz = reg.argmax(("gas", "density"))
>>> t_mrho, v_mrho = reg.argmax(
...     ("gas", "density"),
...     axis=[("gas", "temperature"), ("gas", "velocity_magnitude")],
... )
>>> x, y, z = reg.argmax(("gas", "density"))
argmin(field, axis=None)

Return the values at which the field is minimized.

This will, in a parallel-aware fashion, find the minimum value and then return to you the values at that minimum location that are requested for “axis”. By default it will return the spatial positions (in the natural coordinate system), but it can be any field

Parameters
  • field (string or tuple field name) – The field to minimize.

  • axis (string or list of strings, optional) – If supplied, the fields to sample along; if not supplied, defaults to the coordinate fields. This can be the name of the coordinate fields (i.e., ‘x’, ‘y’, ‘z’) or a list of fields, but cannot be 0, 1, 2.

Returns

Return type

A list of YTQuantities as specified by the axis argument.

Examples

>>> temp_at_min_rho = reg.argmin(
...     ("gas", "density"), axis=("gas", "temperature")
... )
>>> min_rho_xyz = reg.argmin(("gas", "density"))
>>> t_mrho, v_mrho = reg.argmin(
...     ("gas", "density"),
...     axis=[("gas", "temperature"), ("gas", "velocity_magnitude")],
... )
>>> x, y, z = reg.argmin(("gas", "density"))
property blocks
chunks(fields, chunking_style, **kwargs)
clear_data()

Clears out all data from the YTDataContainer instance, freeing memory.

clone()

Clone a data object.

This will make a duplicate of a data object; note that the field_parameters may not necessarily be deeply-copied. If you modify the field parameters in-place, it may or may not be shared between the objects, depending on the type of object that that particular field parameter is.

Notes

One use case for this is to have multiple identical data objects that are being chunked over in different orders.

Examples

>>> ds = yt.load("IsolatedGalaxy/galaxy0030/galaxy0030")
>>> sp = ds.sphere("c", 0.1)
>>> sp_clone = sp.clone()
>>> sp[("gas", "density")]
>>> print(sp.field_data.keys())
[("gas", "density")]
>>> print(sp_clone.field_data.keys())
[]
comm = None
count(selector)
count_particles(selector, x, y, z)
create_firefly_object(path_to_firefly, fields_to_include=None, fields_units=None, default_decimation_factor=100, velocity_units='km/s', coordinate_units='kpc', show_unused_fields=0, dataset_name='yt')

This function links a region of data stored in a yt dataset to the Python frontend API for [Firefly](github.com/ageller/Firefly), a browser-based particle visualization platform.

Parameters
  • path_to_firefly (string) – The (ideally) absolute path to the direction containing the index.html file of Firefly.

  • fields_to_include (array_like of strings) – A list of fields that you want to include in your Firefly visualization for on-the-fly filtering and colormapping.

  • default_decimation_factor (integer) – The factor by which you want to decimate each particle group by (e.g. if there are 1e7 total particles in your simulation you might want to set this to 100 at first). Randomly samples your data like shuffled_data[::decimation_factor] so as to not overtax a system. This is adjustable on a per particle group basis by changing the returned reader’s reader.particleGroup[i].decimation_factor before calling reader.dumpToJSON().

  • velocity_units (string) – The units that the velocity should be converted to in order to show streamlines in Firefly. Defaults to km/s.

  • coordinate_units (string) – The units that the coordinates should be converted to. Defaults to kpc.

  • show_unused_fields (boolean) – A flag to optionally print the fields that are available, in the dataset but were not explicitly requested to be tracked.

  • dataset_name (string) – The name of the subdirectory the JSON files will be stored in (and the name that will appear in startup.json and in the dropdown menu at startup). e.g. yt -> json files will appear in Firefly/data/yt.

Returns

reader – A reader object from the firefly_api, configured to output

Return type

firefly_api.reader.Reader object

Examples

>>> ramses_ds = yt.load(
...     "/Users/agurvich/Desktop/yt_workshop/"
...     + "DICEGalaxyDisk_nonCosmological/output_00002/info_00002.txt"
... )
>>> region = ramses_ds.sphere(ramses_ds.domain_center, (1000, "kpc"))
>>> reader = region.create_firefly_object(
...     path_to_firefly="/Users/agurvich/research/repos/Firefly",
...     fields_to_include=[
...         "particle_extra_field_1",
...         "particle_extra_field_2",
...     ],
...     fields_units=["dimensionless", "dimensionless"],
...     dataset_name="IsoGalaxyRamses",
... )
>>> reader.options["color"]["io"] = [1, 1, 0, 1]
>>> reader.particleGroups[0].decimation_factor = 100
>>> reader.dumpToJSON()
deposit(positions, fields=None, method=None, kernel_name='cubic')

Operate on the mesh, in a particle-against-mesh fashion, with exclusively local input.

This uses the octree indexing system to call a “deposition” operation (defined in yt/geometry/particle_deposit.pyx) that can take input from several particles (local to the mesh) and construct some value on the mesh. The canonical example is to sum the total mass in a mesh cell and then divide by its volume.

Parameters
  • positions (array_like (Nx3)) – The positions of all of the particles to be examined. A new indexed octree will be constructed on these particles.

  • fields (list of arrays) – All the necessary fields for computing the particle operation. For instance, this might include mass, velocity, etc.

  • method (string) – This is the “method name” which will be looked up in the particle_deposit namespace as methodname_deposit. Current methods include count, simple_smooth, sum, std, cic, weighted_mean, mesh_id, and nearest.

  • kernel_name (string, default 'cubic') – This is the name of the smoothing kernel to use. Current supported kernel names include cubic, quartic, quintic, wendland2, wendland4, and wendland6.

Returns

Return type

List of fortran-ordered, mesh-like arrays.

property domain_ind
property fcoords
property fcoords_vertex
fill(fd, fields, selector, file_handler)[source]
property fwidth
get_data(fields=None)
get_dependencies(fields)
get_field_parameter(name, default=None)

This is typically only used by derived field functions, but it returns parameters used to generate fields.

get_vertex_centered_data(fields)
has_field_parameter(name)

Checks if a field parameter is set.

has_key(key)

Checks if a data field already exists.

property icoords
property index
integrate(field, weight=None, axis=None)

Compute the integral (projection) of a field along an axis.

This projects a field along an axis.

Parameters
  • field (string or tuple field name) – The field to project.

  • weight (string or tuple field name) – The field to weight the projection by

  • axis (string) – The axis to project along.

Returns

Return type

YTProjection

Examples

>>> column_density = reg.integrate(("gas", "density"), axis=("index", "z"))
property ires
keys()
mask_refinement(selector)
max(field, axis=None)

Compute the maximum of a field, optionally along an axis.

This will, in a parallel-aware fashion, compute the maximum of the given field. Supplying an axis will result in a return value of a YTProjection, with method ‘mip’ for maximum intensity. If the max has already been requested, it will use the cached extrema value.

Parameters
  • field (string or tuple field name) – The field to maximize.

  • axis (string, optional) – If supplied, the axis to project the maximum along.

Returns

Return type

Either a scalar or a YTProjection.

Examples

>>> max_temp = reg.max(("gas", "temperature"))
>>> max_temp_proj = reg.max(("gas", "temperature"), axis=("index", "x"))
property max_level
mean(field, axis=None, weight=None)

Compute the mean of a field, optionally along an axis, with a weight.

This will, in a parallel-aware fashion, compute the mean of the given field. If an axis is supplied, it will return a projection, where the weight is also supplied. By default the weight field will be “ones” or “particle_ones”, depending on the field being averaged, resulting in an unweighted average.

Parameters
  • field (string or tuple field name) – The field to average.

  • axis (string, optional) – If supplied, the axis to compute the mean along (i.e., to project along)

  • weight (string, optional) – The field to use as a weight.

Returns

Return type

Scalar or YTProjection.

Examples

>>> avg_rho = reg.mean(("gas", "density"), weight="cell_volume")
>>> rho_weighted_T = reg.mean(
...     ("gas", "temperature"), axis=("index", "y"), weight=("gas", "density")
... )
mesh_sampling_particle_field(positions, mesh_field, lvlmax=None)

Operate on the particles, in a mesh-against-particle fashion, with exclusively local input.

This uses the octree indexing system to call a “mesh sampling” operation (defined in yt/geometry/particle_deposit.pyx). For each particle, the function returns the value of the cell containing the particle.

Parameters
  • positions (array_like (Nx3)) – The positions of all of the particles to be examined.

  • mesh_field (array_like (M,)) – The value of the field to deposit.

  • lvlmax (array_like (N), optional) – If provided, the maximum level where to look for cells

Returns

  • List of fortran-ordered, particle-like arrays containing the

  • value of the mesh at the location of the particles.

min(field, axis=None)

Compute the minimum of a field.

This will, in a parallel-aware fashion, compute the minimum of the given field. Supplying an axis is not currently supported. If the max has already been requested, it will use the cached extrema value.

Parameters
  • field (string or tuple field name) – The field to minimize.

  • axis (string, optional) – If supplied, the axis to compute the minimum along.

Returns

Return type

Scalar.

Examples

>>> min_temp = reg.min(("gas", "temperature"))
property min_level
property nz
particle_operation(positions, fields=None, method=None, nneighbors=64, kernel_name='cubic')

Operate on particles, in a particle-against-particle fashion.

This uses the octree indexing system to call a “smoothing” operation (defined in yt/geometry/particle_smooth.pyx) that expects to be called in a particle-by-particle fashion. For instance, the canonical example of this would be to compute the Nth nearest neighbor, or to compute the density for a given particle based on some kernel operation.

Many of the arguments to this are identical to those used in the smooth and deposit functions. Note that the fields argument must not be empty, as these fields will be modified in place.

Parameters
  • positions (array_like (Nx3)) – The positions of all of the particles to be examined. A new indexed octree will be constructed on these particles.

  • fields (list of arrays) – All the necessary fields for computing the particle operation. For instance, this might include mass, velocity, etc. One of these will likely be modified in place.

  • method (string) – This is the “method name” which will be looked up in the particle_smooth namespace as methodname_smooth.

  • nneighbors (int, default 64) – The number of neighbors to examine during the process.

  • kernel_name (string, default 'cubic') – This is the name of the smoothing kernel to use. Current supported kernel names include cubic, quartic, quintic, wendland2, wendland4, and wendland6.

Returns

Return type

Nothing.

partition_index_2d(axis)
partition_index_3d(ds, padding=0.0, rank_ratio=1)
partition_index_3d_bisection_list()

Returns an array that is used to drive _partition_index_3d_bisection, below.

partition_region_3d(left_edge, right_edge, padding=0.0, rank_ratio=1)

Given a region, it subdivides it into smaller regions for parallel analysis.

property pf
profile(bin_fields, fields, n_bins=64, extrema=None, logs=None, units=None, weight_field='gas', 'mass', accumulation=False, fractional=False, deposition='ngp')

Create a 1, 2, or 3D profile object from this data_source.

The dimensionality of the profile object is chosen by the number of fields given in the bin_fields argument. This simply calls yt.data_objects.profiles.create_profile().

Parameters
  • bin_fields (list of strings) – List of the binning fields for profiling.

  • fields (list of strings) – The fields to be profiled.

  • n_bins (int or list of ints) – The number of bins in each dimension. If None, 64 bins for each bin are used for each bin field. Default: 64.

  • extrema (dict of min, max tuples) – Minimum and maximum values of the bin_fields for the profiles. The keys correspond to the field names. Defaults to the extrema of the bin_fields of the dataset. If a units dict is provided, extrema are understood to be in the units specified in the dictionary.

  • logs (dict of boolean values) – Whether or not to log the bin_fields for the profiles. The keys correspond to the field names. Defaults to the take_log attribute of the field.

  • units (dict of strings) – The units of the fields in the profiles, including the bin_fields.

  • weight_field (str or tuple field identifier) – The weight field for computing weighted average for the profile values. If None, the profile values are sums of the data in each bin.

  • accumulation (bool or list of bools) – If True, the profile values for a bin n are the cumulative sum of all the values from bin 0 to n. If -True, the sum is reversed so that the value for bin n is the cumulative sum from bin N (total bins) to n. If the profile is 2D or 3D, a list of values can be given to control the summation in each dimension independently. Default: False.

  • fractional (If True the profile values are divided by the sum of all) – the profile data such that the profile represents a probability distribution function.

  • deposition (Controls the type of deposition used for ParticlePhasePlots.) – Valid choices are ‘ngp’ and ‘cic’. Default is ‘ngp’. This parameter is ignored the if the input fields are not of particle type.

Examples

Create a 1d profile. Access bin field from profile.x and field data from profile[<field_name>].

>>> ds = load("DD0046/DD0046")
>>> ad = ds.all_data()
>>> profile = ad.profile(
...     ad,
...     [("gas", "density")],
...     [("gas", "temperature"), ("gas", "velocity_x")],
... )
>>> print(profile.x)
>>> print(profile["gas", "temperature"])
>>> plot = profile.plot()
ptp(field)

Compute the range of values (maximum - minimum) of a field.

This will, in a parallel-aware fashion, compute the “peak-to-peak” of the given field.

Parameters

field (string or tuple field name) – The field to average.

Returns

Return type

Scalar

Examples

>>> rho_range = reg.ptp(("gas", "density"))
retrieve_ghost_zones(ngz, fields, smoothed=False)[source]
save_as_dataset(filename=None, fields=None)

Export a data object to a reloadable yt dataset.

This function will take a data object and output a dataset containing either the fields presently existing or fields given in the fields list. The resulting dataset can be reloaded as a yt dataset.

Parameters
  • filename (str, optional) – The name of the file to be written. If None, the name will be a combination of the original dataset and the type of data container.

  • fields (list of string or tuple field names, optional) – If this is supplied, it is the list of fields to be saved to disk. If not supplied, all the fields that have been queried will be saved.

Returns

filename – The name of the file that has been created.

Return type

str

Examples

>>> import yt
>>> ds = yt.load("enzo_tiny_cosmology/DD0046/DD0046")
>>> sp = ds.sphere(ds.domain_center, (10, "Mpc"))
>>> fn = sp.save_as_dataset(fields=[("gas", "density"), ("gas", "temperature")])
>>> sphere_ds = yt.load(fn)
>>> # the original data container is available as the data attribute
>>> print(sds.data[("gas", "density")])
[  4.46237613e-32   4.86830178e-32   4.46335118e-32 ...,   6.43956165e-30
   3.57339907e-30   2.83150720e-30] g/cm**3
>>> ad = sphere_ds.all_data()
>>> print(ad[("gas", "temperature")])
[  1.00000000e+00   1.00000000e+00   1.00000000e+00 ...,   4.40108359e+04
   4.54380547e+04   4.72560117e+04] K
select(selector, source, dest, offset)
select_blocks(selector)
select_fcoords(dobj)
select_fwidth(dobj)
select_icoords(dobj)
select_ires(dobj)
select_particles(selector, x, y, z)
select_tcoords(dobj)
property selector
set_field_parameter(name, val)

Here we set up dictionaries that get passed up and down and ultimately to derived fields.

smooth(positions, fields=None, index_fields=None, method=None, create_octree=False, nneighbors=64, kernel_name='cubic')

Operate on the mesh, in a particle-against-mesh fashion, with non-local input.

This uses the octree indexing system to call a “smoothing” operation (defined in yt/geometry/particle_smooth.pyx) that can take input from several (non-local) particles and construct some value on the mesh. The canonical example is to conduct a smoothing kernel operation on the mesh.

Parameters
  • positions (array_like (Nx3)) – The positions of all of the particles to be examined. A new indexed octree will be constructed on these particles.

  • fields (list of arrays) – All the necessary fields for computing the particle operation. For instance, this might include mass, velocity, etc.

  • index_fields (list of arrays) – All of the fields defined on the mesh that may be used as input to the operation.

  • method (string) – This is the “method name” which will be looked up in the particle_smooth namespace as methodname_smooth. Current methods include volume_weighted, nearest, idw, nth_neighbor, and density.

  • create_octree (bool) – Should we construct a new octree for indexing the particles? In cases where we are applying an operation on a subset of the particles used to construct the mesh octree, this will ensure that we are able to find and identify all relevant particles.

  • nneighbors (int, default 64) – The number of neighbors to examine during the process.

  • kernel_name (string, default 'cubic') – This is the name of the smoothing kernel to use. Current supported kernel names include cubic, quartic, quintic, wendland2, wendland4, and wendland6.

Returns

Return type

List of fortran-ordered, mesh-like arrays.

std(field, weight=None)

Compute the standard deviation of a field.

This will, in a parallel-ware fashion, compute the standard deviation of the given field.

Parameters
  • field (string or tuple field name) – The field to calculate the standard deviation of

  • weight (string or tuple field name) – The field to weight the standard deviation calculation by. Defaults to unweighted if unset.

Returns

Return type

Scalar

sum(field, axis=None)

Compute the sum of a field, optionally along an axis.

This will, in a parallel-aware fashion, compute the sum of the given field. If an axis is specified, it will return a projection (using method type “sum”, which does not take into account path length) along that axis.

Parameters
  • field (string or tuple field name) – The field to sum.

  • axis (string, optional) – If supplied, the axis to sum along.

Returns

Return type

Either a scalar or a YTProjection.

Examples

>>> total_vol = reg.sum("cell_volume")
>>> cell_count = reg.sum(("index", "ones"), axis=("index", "x"))
property tiles
to_astropy_table(fields)

Export region data to a :class:~astropy.table.table.QTable, which is a Table object which is unit-aware. The QTable can then be exported to an ASCII file, FITS file, etc.

See the AstroPy Table docs for more details: http://docs.astropy.org/en/stable/table/

Parameters

fields (list of strings or tuple field names) – This is the list of fields to be exported into the QTable.

Examples

>>> sp = ds.sphere("c", (1.0, "Mpc"))
>>> t = sp.to_astropy_table([("gas", "density"), ("gas", "temperature")])
to_dataframe(fields)

Export a data object to a DataFrame.

This function will take a data object and an optional list of fields and export them to a DataFrame object. If pandas is not importable, this will raise ImportError.

Parameters

fields (list of strings or tuple field names) – This is the list of fields to be exported into the DataFrame.

Returns

df – The data contained in the object.

Return type

DataFrame

Examples

>>> dd = ds.all_data()
>>> df = dd.to_dataframe([("gas", "density"), ("gas", "temperature")])
to_glue(fields, label='yt', data_collection=None)

Takes specific fields in the container and exports them to Glue (http://glueviz.org) for interactive analysis. Optionally add a label. If you are already within the Glue environment, you can pass a data_collection object, otherwise Glue will be started.

write_out(filename, fields=None, format='%0.16e')

Write out the YTDataContainer object in a text file.

This function will take a data object and produce a tab delimited text file containing the fields presently existing and the fields given in the fields list.

Parameters
  • filename (String) – The name of the file to write to.

  • fields (List of string, Default = None) – If this is supplied, these fields will be added to the list of fields to be saved to disk. If not supplied, whatever fields presently exist will be used.

  • format (String, Default = "%0.16e") – Format of numbers to be written in the file.

Raises
  • ValueError – Raised when there is no existing field.

  • YTException – Raised when field_type of supplied fields is inconsistent with the field_type of existing fields.

Examples

>>> ds = fake_particle_ds()
>>> sp = ds.sphere(ds.domain_center, 0.25)
>>> sp.write_out("sphere_1.txt")
>>> sp.write_out("sphere_2.txt", fields=["cell_volume"])
class yt.frontends.ramses.data_structures.RAMSESFileSanitizer(filename)[source]

Bases: object

A class to handle the different files that can be passed and associated safely to a RAMSES output.

static check_standard_files(folder, iout)[source]

Return True if the folder contains an amr file and the info file.

group_name = None
info_fname = None
property is_valid
root_folder = None
classmethod test_with_folder_name(output_dir)[source]
classmethod test_with_standard_file(filename)[source]
class yt.frontends.ramses.data_structures.RAMSESIndex(ds, dataset_type='ramses')[source]

Bases: yt.geometry.oct_geometry_handler.OctreeIndex

comm = None
convert(unit)
get_data(node, name)

Return the dataset with a given name located at node in the datafile.

get_dependencies(fields)
get_smallest_dx()

Returns (in code units) the smallest cell size in the simulation.

partition_index_2d(axis)
partition_index_3d(ds, padding=0.0, rank_ratio=1)
partition_index_3d_bisection_list()

Returns an array that is used to drive _partition_index_3d_bisection, below.

partition_region_3d(left_edge, right_edge, padding=0.0, rank_ratio=1)

Given a region, it subdivides it into smaller regions for parallel analysis.

print_stats()[source]

Prints out (stdout) relevant information about the simulation

This function prints information based on the fluid on the grids, and therefore does not work for DM only runs.

save_data(array, node, name, set_attr=None, force=False, passthrough=False)

Arbitrary numpy data will be saved to the region in the datafile described by node and name. If data file does not exist, it throws no error and simply does not save.