export

hydromodpy.export(sim, var, dest, *, fmt=None, time=None, layer=None, resolution=None, crs=None, nodata=-9999.0)

Export a variable from a simulation to a standalone file.

Functional mirror of read(): same selector (sim / var / time / layer) plus an output format and destination. sim must be a Run, as returned by hmp.open(workspace)[ref] or catalog.latest().

fmt is optional when dest carries a known extension (.nc -> netcdf, .tif -> geotiff, .csv -> csv, .shp -> shapefile, .vtu -> vtu, .hmp -> portable package).

Return type:

Path

Parameters:

• sim (Any)

• var (str | list[str])

• dest (Any)

• fmt (str | None)

• time (int | str | None)

• layer (int | None)

• resolution (float | None)

• crs (str | None)

• nodata (float)

Examples

>>> import hydromodpy as hmp
>>> run = hmp.open("~/hmp_workspace")["transient_nwt"]  
>>> hmp.export(
...     run, "head", "head.tif", time="last", resolution=50
... )  
>>> hmp.export(
...     run, ["head", "watertable_depth"], "fields.nc", time="all"
... )  

param sim:

type sim:

Any

param var:

type var:

str | list[str]

param dest:

type dest:

Any

param fmt:

type fmt:

str | None

param time:

type time:

int | str | None

param layer:

type layer:

int | None

param resolution:

type resolution:

float | None

param crs:

type crs:

str | None

param nodata:

type nodata:

float