Suxarray

suxarray is an extension of uxarray for SCHISM grids.

SCHISM grid

The SCHISM grid is a horizontal unstructured grid with a layered vertical grid. It uses a mixture of triangular and quadrilateral horizontal elements. The vertical grid can be a hybrid sigma and z coordinate system (SZ grid) or a variable number of sigma layers (LSC2). The SCHISM grid is described in the SCHISM manual (https://schism-dev.github.io/schism/master/index.html). The SCHISM uses UGRID convention in its NetCDF output files.

Goals

suxarray is intended to use xarray through uxarray while keeping and handling SCHISM grid-specific information. Also, it will provide useful operations for SCHISM grid data.

Note

suxarray is actively being developed, and uxarray that suxarray depends on change rapidly, too. Hence, API may change frequently. It is recommended to use a specific version of suxarray and uxarray together to avoid incompatibility issues, and document the versions of the suxarray and uxarray that you use in your project later use.

Installation

Please see the installation section in the documentation at https://cadwrdeltamodeling.github.io/suxarray/main/installation.html.

Documentation

The full documentation is at GitHub https://cadwrdeltamodeling.github.io/suxarray/.

License

suxarray is licensed under the MIT license. See the LICENSE file for more information.