xamr

User Guide:

  • User Guide

API Reference:

  • API Reference
    • AMReXDataset
    • AMReXDataArray
    • AMReXCalculations
    • Core Classes
      • xamr.AMReXDataset
      • xamr.AMReXDataArray
      • xamr.AMReXCalculations

Examples:

  • Examples
xamr
  • API Reference
  • View page source

API Reference

This section provides detailed API documentation for all xamr classes and functions.

  • AMReXDataset
    • AMReXDataset
    • xamr.AMReXDataset.__init__
    • xamr.AMReXDataset.__getitem__
    • xamr.AMReXDataset.attrs
    • xamr.AMReXDataset.levels
    • xamr.AMReXDataset.calc
    • xamr.AMReXDataset._setup_time_series
    • xamr.AMReXDataset._setup_coarsest_grid
    • xamr.AMReXDataset._build_coordinates
    • xamr.AMReXDataset._build_data_vars
  • AMReXDataArray
    • AMReXDataArray
    • xamr.AMReXDataArray.__init__
    • xamr.AMReXDataArray.__getitem__
    • xamr.AMReXDataArray.level_select
    • xamr.AMReXDataArray.spatial_select
    • xamr.AMReXDataArray.sel
    • xamr.AMReXDataArray.max
    • xamr.AMReXDataArray.min
    • xamr.AMReXDataArray.mean
    • xamr.AMReXDataArray.values
    • xamr.AMReXDataArray.data
    • xamr.AMReXDataArray.coords
    • xamr.AMReXDataArray.dims
    • xamr.AMReXDataArray.shape
    • xamr.AMReXDataArray._load_coarsest_data
  • AMReXCalculations
    • AMReXCalculations
    • xamr.AMReXCalculations.__init__
    • xamr.AMReXCalculations.gradient
    • xamr.AMReXCalculations.divergence
    • xamr.AMReXCalculations.vorticity

Core Classes

xamr.AMReXDataset(filename)

xarray-like interface for AMReX data via yt (native AMR)

xamr.AMReXDataArray(parent_ds, field_name[, ...])

xarray-like DataArray for AMR fields

xamr.AMReXCalculations(dataset)

Atmospheric/oceanic calculations using yt's AMR-native operations

Previous Next

© Copyright 2025, xamr developers.

Built with Sphinx using a theme provided by Read the Docs.