XGC‑Analysis Python API

XGC-Analysis is a Python library for inspecting XGC simulation output and running scientific analyses on it. Its catalog discovers BP products and their logical steps, and its readers load selected variables. Simulation combines the run input, mesh, magnetic field, species, and catalog for analyses that need the full XGC context. Analysis functions can be called from scripts and notebooks; the XGC GUI Monitor uses them through separate plugins.

The package includes reusable analysis routines and a production Diffusion Optimizer application. The optimizer is launched as a standalone Python script alongside XGC. It is not a Monitor plugin. The current module listing below documents the existing API.

Start with Installation and Python environment, then see Data Access Architecture for catalog concepts, Simulation core for the simulation objects, Prescribed species profiles for species inputs, and XGC-Analysis package for API details. See Reusable analysis workflows for reusable computations, plots, and standalone workflow entry points.

Back to the XGC-Documentation.

Guide and API

• Installation and Python environment
  • Compatibility and campaign archives
  • Build ADIOS2 Python bindings from source
• Data Access Architecture
  • Current implementation status
  • Run manifests and text artifacts
  • Catalog inspection APIs
  • Catalog discovery
  • Logical steps
  • Read planning
  • Read-plan execution
  • Static product reads
  • Raw catalog reads
  • Existing reader storage
  • Backend boundary
• Simulation core
  • Coordinates and indexing
  • Construction and resource use
• Prescribed species profiles
  • Profile families
  • Spatial and runtime limits
  • References and checks
• Reusable analysis workflows
  • Selection and provenance
• Diffusion Optimizer workflow
  • Data flow
  • Fitting order and coefficient updates
  • Learned response correction
  • Diagnostics and control switches
  • Model boundary
  • Workflow stream classes
• XGC-Analysis package
  • Module xgc_analysis.data_access.products.accessor_mixin
  • Module xgc_analysis.data_access.adios.adios_stream
  • Module xgc_analysis.data_access.adios.adios_file_reader
  • Module xgc_analysis.data_access.products.bp_reader_mixin
  • Module xgc_analysis.data_access.catalog.directory_catalog
  • Module xgc_analysis.data_access.catalog.campaign_catalog
  • Module xgc_analysis.data_access.catalog.campaign_source_reader
  • Module xgc_analysis.data_access.catalog.read_plan_executor
  • Module xgc_analysis.data_access.catalog.static_product_reader
  • Module xgc_analysis.data_access.catalog.types
  • Module xgc_analysis.constants
  • Module xgc_analysis.mesh.csr_matrix
  • Module xgc_analysis.data_access.products.distribution_function_data
  • Module xgc_analysis.analysis.moments.distribution
  • Module xgc_analysis.data_access.products.diffusion_data
  • Module xgc_analysis.analysis.divertor.eich
  • Module xgc_analysis.data_access.products.field_data
  • Module xgc_analysis.mesh.fieldline_mapping
  • Module xgc_analysis.mesh.fieldline_mapping2
  • Module xgc_analysis.data_access.products.fmoment_data
  • Module xgc_analysis.data_access.products.fsource_data
  • Module xgc_analysis.data_access.products.heatdiag
  • Module xgc_analysis.data_access.products.loop_voltage_data
  • Module xgc_analysis.magnetic_equilibrium.magnetic_field
  • Module xgc_analysis.mesh.mesh
  • Module xgc_analysis.mesh.mesh_data
  • Module xgc_analysis.data_access.products.neutral_data
  • Module xgc_analysis.data_access.products.oneddiag
  • Module xgc_analysis.species.periodic_table
  • Module xgc_analysis.mesh.plane
  • Module xgc_analysis.mesh.plane_data
  • Module xgc_analysis.mesh.plotting
  • Module xgc_analysis.data_access.adios.read_bp_file
  • Module xgc_analysis.data_access.products.sheath_data
  • Module xgc_analysis.simulation.simulation
  • Module xgc_analysis.analysis.divertor.wall_loss_rates
  • Module xgc_analysis.mesh.sol_wall_mapping
  • Module xgc_analysis.species.species
  • Module xgc_analysis.species.prescribed_profiles
  • Module xgc_analysis.time_step_utils
  • Module xgc_analysis.utils.file_waiter
  • Module xgc_analysis.simulation.velocity_grid
  • Module xgc_analysis.mesh.wall_curve
  • Module contents
  • Stage 5 analysis modules
• Back to the XGC Documentation