Usage: pgkyl load [OPTIONS]
Read Gkeyll output into a fluent ``GData`` or ``GDataGroup``.
``pg.load('elc_M0_0.gkyl').interpolate().select(z0=0.0).plot()``
Shell-style glob patterns (``*``, ``?``, and ``[]``) load every matching file into a
:class:`GDataGroup`, naturally ordered by filename. The group broadcasts per-dataset
verbs and supplies the multi-dataset ``collect`` verb, so a frame series can be loaded
and stacked in one chain::
pg.load('elc_M0_*.gkyl').interpolate().collect().plot()
A pattern always returns a group, even if it matches only one file. A literal filename
retains the original single-``GData`` return type.
``basis_type``, ``poly_order``, and ``value_form`` are properties of the data itself,
fixed here at load time (from the file's header metadata, or the override below) -- no
downstream verb (``interpolate``, ``average``, ...) ever re-specifies them; they
always read ``ctx["basis_type"]``/ ``ctx["poly_order"]``/``ctx["value_form"]`` off the
loaded dataset.
``value_form`` overrides the ``"modal"``/``"nodal"``/``"quad"`` tag the file's header
metadata would otherwise imply -- for files whose writer stamps DG basis metadata even
though the stored values are already point values (e.g. a per-cell diagnostic like a
CFL rate), not modal coefficients.
``basis_type`` overrides the ``"basis_type"`` (e.g. ``"serendipity"``, ``"tensor"``,
``"gkhybrid"``) the file's header metadata would otherwise imply -- for files with no
basis metadata at all, or metadata that mislabels the basis actually used. Setting it
also defaults ``value_form`` to ``"modal"`` (unless ``value_form`` is given too), so
downstream verbs that read ``ctx["basis_type"]`` resolve the right basis.
``poly_order`` overrides the ``"poly_order"`` the file's header metadata would
otherwise imply. It is independent of ``basis_type``/``value_form`` -- passing it
alone corrects only the polynomial order and asserts nothing about whether the dataset
is modal.
Options:
-f, --file_name TEXT Literal filename or shell-style glob pattern to load.
[required]
-t, --tag TEXT Tag assigned to every loaded dataset. [default:
default]
-l, --label TEXT Optional display label assigned to every loaded
dataset. [default: ""]
-c, --ctx TEXT Initial metadata as repeated key/value entries.
-v, --value_form [modal|nodal|quad]
Stored representation of the loaded values.
-b, --basis_type TEXT DG basis name overriding file metadata.
-p, --poly_order INTEGER Polynomial order overriding file metadata.
-z, --z0 TEXT Partial-load selector for coordinate direction 0.
--z1 TEXT Partial-load selector for coordinate direction 1.
--z2 TEXT Partial-load selector for coordinate direction 2.
--z3 TEXT Partial-load selector for coordinate direction 3.
--z4 TEXT Partial-load selector for coordinate direction 4.
--z5 TEXT Partial-load selector for coordinate direction 5.
--component TEXT Partial-load component selector.
-r, --read_options TEXT Reader-specific options as repeated key/value entries.
--help Show this message and exit.