astronomix package

Subpackages

• astronomix.analysis_helpers package
  • Submodules
    • astronomix.analysis_helpers.energy_spectrum module
      • get_cross_helicity_spectrum()
      • get_kinetic_energy_spectrum()
      • get_magnetic_energy_spectrum()
      • get_magnetic_helicity_spectrum()
      • vector_field_cross_spectrum()
      • vector_field_energy_spectrum()
    • astronomix.analysis_helpers.jacobians module
      • single_xmode_jacobian2Dt()
      • single_xmode_rhs_jacobian2D()
  • Module contents
• astronomix.data_classes package
  • Submodules
    • astronomix.data_classes.simulation_helper_data module
      • HelperData
      • HelperDataRequirements
      • get_helper_data()
    • astronomix.data_classes.simulation_snapshot_data module
      • SnapshotData
    • astronomix.data_classes.simulation_state_struct module
      • StateStruct
  • Module contents
• astronomix.initial_condition_generation package
  • Submodules
    • astronomix.initial_condition_generation.construct_primitive_state module
      • construct_primitive_state()
    • astronomix.initial_condition_generation.magnetic_field_from_vector_potential module
      • setup_magnetic_fields_from_vector_potential()
    • astronomix.initial_condition_generation.turbulent_ic_generator module
      • create_turb_field()
  • Module contents
• astronomix.option_classes package
  • Submodules
    • astronomix.option_classes.simulation_config module
      • BoundarySettings
      • BoundarySettings1D
      • GravityConfig
      • OPTIMAL_BACKEND
      • POSITIVITY_CONSERVATIVE
      • PositivityConfig
      • SimulationConfig
      • SnapshotSettings
      • StaticFloatVector
      • StaticIntVector
      • config_to_string()
      • finalize_config()
      • gpu_compute_capability_at_least_80()
      • limiter_to_string()
      • riemann_solver_to_string()
      • solver_mode_to_string()
    • astronomix.option_classes.simulation_params module
      • FixedBoundaryState
      • FixedBoundaryState1D
      • SimulationParams
  • Module contents
• astronomix.plotting_helpers package
  • Submodules
    • astronomix.plotting_helpers.inset_box module
      • add_inset_box()
    • astronomix.plotting_helpers.power_law_indicators module
      • add_power_law_indicators()
  • Module contents
• astronomix.setup_helpers package
  • Submodules
    • astronomix.setup_helpers.restart module
      • latest_checkpoint_step()
      • restart_from_latest_checkpoint()
  • Module contents
    • latest_checkpoint_step()
    • restart_from_latest_checkpoint()
• astronomix.shock_finder package
  • Submodules
    • astronomix.shock_finder.shock_finder module
      • find_shock_zone()
      • shock_criteria()
      • shock_sensor()
  • Module contents
• astronomix.time_stepping package
  • Submodules
    • astronomix.time_stepping.time_integration module
      • LoopState
      • time_integration()
  • Module contents
• astronomix.units package
  • Submodules
    • astronomix.units.unit_helpers module
      • CodeUnits
  • Module contents

Module contents

astronomix: a differentiable finite-volume / finite-difference (magneto)hydrodynamics code.

This top-level package re-exports the most commonly used entry points — the configuration and parameter containers, the variable registry, the initial condition helpers and the time_integration driver — so that user scripts can import them directly from astronomix.