From f436240ea0abd3b8d0d0bedcf40882f1589405b1 Mon Sep 17 00:00:00 2001 From: Gabriele Bozzola Date: Wed, 29 May 2024 14:33:00 -0700 Subject: [PATCH] Add more documentation on NetCDFWriter space The space of definition of the NetCDFWriter is primarily used to look at the vertical direction. As such, we need to pass a space with the vertical direction. From there, we can take slices (but the oppsite is no true). --- src/netcdf_writer.jl | 4 +++- 1 file changed, 3 insertions(+), 1 deletion(-) diff --git a/src/netcdf_writer.jl b/src/netcdf_writer.jl index 807f8a4b..68807eda 100644 --- a/src/netcdf_writer.jl +++ b/src/netcdf_writer.jl @@ -85,7 +85,9 @@ performing a pointwise (non-conservative) remapping first. Keyword arguments ================== -- `space`: `Space` where the `Fields` are defined. +- `space`: `Space` where the `Fields` are defined. This is the most general space across the + `Fields`. In general, this is a 3D space. From a 3D space, you can take slices and + write 2D Fields, but the opposite is not true. - `output_dir`: The base folder where the files should be saved. - `num_points`: How many points to use along the different dimensions to interpolate the fields. This is a tuple of integers, typically having meaning Long-Lat-Z,