Skip to content

Commit

Permalink
Add more documentation on NetCDFWriter space
Browse files Browse the repository at this point in the history
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).
  • Loading branch information
Sbozzolo committed May 29, 2024
1 parent 6d10377 commit f436240
Showing 1 changed file with 3 additions and 1 deletion.
4 changes: 3 additions & 1 deletion src/netcdf_writer.jl
Original file line number Diff line number Diff line change
Expand Up @@ -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,
Expand Down

0 comments on commit f436240

Please sign in to comment.