Analysis

Post-processing functions that compute derived quantities from raw simulation output. Each reads simulation_data.nc and writes a NetCDF file into the analysis/ subdirectory of the simulation's save directory (see Output & data for the layout and schema).

Compatibility

Function	Steady-State results	Time-Dependent results
`make_volume_excitation_file`	✓	✓
`make_column_excitation_file`	✓	✓
`make_Ie_top_file`	✓	✓
`make_current_file`	✓	✓
`make_heating_rate_file`	✓	✓
`make_psd_file`		✓

Excitation rates

AURORA.make_volume_excitation_file — Function

make_volume_excitation_file(directory_to_process)

Read simulation_data.nc and inputs/atmosphere.nc from directory_to_process, compute volume-excitation-rates for all tracked optical emissions and ionizations, and write results to analysis/volume_excitation.nc.

Returns a VolumeExcitationResult.

Keyword arguments

max_bytes: per-chunk memory budget for streaming the flux (default 512 MiB).

source

make_volume_excitation_file(sim::AuroraSimulation)

Convenience wrapper that calls make_volume_excitation_file on sim.output.savedir.

source

AURORA.make_column_excitation_file — Function

make_column_excitation_file(directory_to_process)

Read analysis/volume_excitation.nc from directory_to_process, integrate volume-excitation-rates in altitude (accounting for finite photon travel time), and write results to analysis/column_excitation.nc.

Returns a ColumnExcitationResult.

source

make_column_excitation_file(sim::AuroraSimulation)

Convenience wrapper that calls make_column_excitation_file on sim.output.savedir.

source

Top-of-model flux

AURORA.make_Ie_top_file — Function

make_Ie_top_file(directory_to_process)

Read simulation_data.nc from directory_to_process, extract the electron flux at the top of the ionosphere (highest altitude), and write results to analysis/Ie_top.nc.

Calling

make_Ie_top_file(directory_to_process)

Inputs

directory_to_process: absolute or relative path to the simulation directory.

source

make_Ie_top_file(sim::AuroraSimulation)

Convenience wrapper that calls make_Ie_top_file on sim.output.savedir.

source

Current and heating

AURORA.make_current_file — Function

make_current_file(directory_to_process)

Read simulation_data.nc from directory_to_process, compute field-aligned current density and energy flux, and write results to analysis/currents.nc.

Calling

make_current_file(directory_to_process)

Keyword arguments

max_bytes: per-chunk memory budget for streaming the flux (default 512 MiB).

source

make_current_file(sim::AuroraSimulation)

Convenience wrapper that calls make_current_file on sim.output.savedir.

source

AURORA.make_heating_rate_file — Function

make_heating_rate_file(directory_to_process)

Read simulation_data.nc and inputs/atmosphere.nc from directory_to_process, compute the thermal-electron heating rate by superthermal electrons, and write results to analysis/heating_rate.nc.

Calling

make_heating_rate_file(directory_to_process)

Inputs

directory_to_process: absolute or relative path to the simulation directory.

Keyword arguments

max_bytes: per-chunk memory budget for streaming the flux (default 512 MiB).

source

make_heating_rate_file(sim::AuroraSimulation)

Convenience wrapper that calls make_heating_rate_file on sim.output.savedir.

source

Phase space density

AURORA.make_psd_file — Function

make_psd_file(directory_to_process; compute=:both, vpar_edges=nothing, max_bytes=512*1024^2, compress=false, show_progress=false)

Read simulation_data.nc from directory_to_process, convert electron flux to phase-space density, and write results to analysis/psd.nc.

The flux is streamed over time-chunks and the phase-space density is written to disk chunk by chunk, so peak memory stays bounded even for large runs.

Keyword Arguments

compute: one of :f_only, :F_only, or :both.
vpar_edges: custom v_parallel bin edges [m/s]. If nothing, an automatic symmetric uniform grid is used spanning [-maximum(v), maximum(v)].
max_bytes: per-chunk memory budget for streaming the flux (default 512 MiB).
compress: zlib compression level for the f and F variables, with the same semantics as in AuroraOutputManager: false/0 (default, no compression), true (level 4), or an exact level 1–9.
show_progress: show a ProgressMeter progress bar while streaming chunks (default false).

source

make_psd_file(sim::AuroraSimulation; kwargs...)

Convenience wrapper that calls make_psd_file on sim.output.savedir.

source