cli.NetcdfPreprocessBatchConfig

cli.NetcdfPreprocessBatchConfig(
    script,
    simulation,
    data_file,
    variable,
    units,
    output,
    target,
    x_coord='lon',
    y_coord='lat',
    time_coord='time',
    timestep=None,
    time_type=None,
    time_start=None,
    time_unit=None,
    time_count=None,
    time_increment=None,
    time_interval=None,
    time_instant=None,
    crs=None,
    default_value=None,
    parallel=False,
    amend=False,
    no_wait=False,
    poll_interval=None,
    timeout=None,
)

Batch-dispatch a NetCDF file to a remote target as .jshd.

The remote counterpart of :class:NetcdfPreprocessConfig: same temporal axis semantics, dispatched via preprocessBatch instead of run locally. For a flat, timeless NetCDF (e.g. a 2D raster), set time_coord=None to emit --no-time-dim instead of looking for a time dimension.

Attributes

Name	Type	Description
script	Path	Path to .josh file.
simulation	str	Name of simulation.
data_file	Path	Path to NetCDF file (.nc, .nc4, .netcdf).
variable	str	NetCDF variable name to extract (e.g., “tas”, “pr”).
units	str	Units of the data.
output	Path	Output .jshd file path.
target	str	Target profile name (required).
x_coord	str	Name of X/longitude dimension (default: “lon”).
y_coord	str	Name of Y/latitude dimension (default: “lat”).
time_coord	str | None	Name of time dimension (default: “time”). Set to None for a source with no time dimension at all.
timestep	int | None	Extract specific time slice (optional).
time_type	str | None	Declared JSHD time axis type: "count" or "ISO".
time_start	str | int | float | None	First count coordinate or ISO start date.
time_unit	str | None	Unit for a count axis.
time_count	int | None	Number of declared temporal coordinates.
time_increment	int | float | None	Increment between count coordinates.
time_interval	str | None	ISO-8601 date period between ISO dates (e.g. "P1M").
time_instant	str | int | float | None	Single count coordinate or ISO date for one output slice.
crs	str | None	CRS to use when reading the file.
default_value	float | None	Default value to fill grid spaces before copying data.
parallel	bool	Enable parallel processing of patches within each timestep.
amend	bool	Amend existing output file rather than overwriting.
no_wait	bool	If True, dispatch and exit without polling for completion.
poll_interval	int | None	Polling interval in seconds (optional).
timeout	int | None	Maximum seconds to wait for completion (optional).