AthenaKit

User Guide

  • Getting Started
    • Installation
      • Requirements
      • Install from source
      • Enabling GPU support
      • Enabling MPI support
    • Quickstart
      • Load a snapshot
      • Inspect available variables
      • Access data
      • Compute a radial profile
      • Make a slice plot
      • Save and reload processed data
      • Next steps
  • Examples
    • Bondi Accretion
      • Setup
      • Radial profiles
      • Accretion rate
    • Magnetized Torus (GRMHD)
      • Load and inspect
      • Slice plots
      • Phase diagrams
      • GR-specific variables
    • Supernova Remnant
      • Load and explore
      • Shock front radius
      • Sedov-Taylor comparison

API Reference

  • API Reference
    • athenakit.athena_data
      • Top-level loader
        • load()
      • AthenaData
        • AthenaData
      • AthenaDataSet
        • AthenaDataSet
    • athenakit.kit
      • Data conversion
        • bin_to_athdf()
        • bins_to_athdfs()
      • Cooling functions
        • CoolFnShure()
        • CoolFnShure_numpy()
      • Visualization helpers
        • figure()
        • subplots()
        • colors()
        • truncate_colormap()
      • Math utilities
        • ave()
        • smooth()
        • quantile()
        • RK4()
    • athenakit.io
      • Binary reader
        • read_binary()
        • write_athdf()
        • write_xdmf_for()
      • HDF5 / athdf reader
        • hst()
        • hst_complex()
        • tab()
    • athenakit.physics
      • GRMHD
        • cks_geometry()
        • cks_to_sks_tens_con()
        • cks_to_sks_vec_con()
        • cks_to_sks_vec_cov()
        • functions()
        • lower_vector()
        • norm_to_coord()
        • normal_lorentz()
        • r_horizon()
        • three_to_four_field()
        • variables()
      • Metric
        • kerr_schild_metric_and_inverse()
        • kerr_schild_radius()
      • SNR
        • SNR_ABC
        • SNR_SedovTaylor
        • SNR_WhiteLong
        • SNR_evo
        • SNR_mpe
        • SedovTaylor
    • athenakit.units
      • Units
        • Units.__init__()
        • Units.conductivity_cgs
        • Units.cooling_cgs
        • Units.density_cgs
        • Units.energy_cgs
        • Units.entropy_kevcm2
        • Units.grav_constant
        • Units.heating_cgs
        • Units.magnetic_field_cgs
        • Units.number_density_cgs
        • Units.pressure_cgs
        • Units.speed_of_light
        • Units.temperature_cgs
        • Units.velocity_cgs
    • athenakit.vis
      • Bipolar
        • bipolar()
        • hotcold()
    • athenakit.app
      • Bondi accretion
        • add_data()
        • add_gr_data()
        • add_tools()
      • Magnetized torus
        • add_data()
        • add_tools()
      • Accretion disk
        • InitialCondition
        • add_data()
        • add_gradient()
        • add_tools()
        • add_tran()
      • Supernova remnant
        • to_yt()
        • xray()
      • Magnetized disk (mdisk)
        • add_data()
        • add_tools()
AthenaKit
  • Search

© Copyright 2026, AthenaKit Developers.

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