Skip to content

Commit

Permalink
Link to supported grid types in documentation
Browse files Browse the repository at this point in the history
  • Loading branch information
natgeo-wong committed Oct 8, 2024
1 parent 1d2a06d commit 23c7639
Show file tree
Hide file tree
Showing 3 changed files with 38 additions and 3 deletions.
3 changes: 3 additions & 0 deletions docs/src/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -13,6 +13,9 @@ hero:
- theme: brand
text: Getting Started
link: /regiongrids
- theme: alt
text: Grid Types
link: /types
- theme: alt
text: Tutorials
link: /tutorials
Expand Down
8 changes: 5 additions & 3 deletions docs/src/regiongrids.md
Original file line number Diff line number Diff line change
Expand Up @@ -14,10 +14,12 @@ The `RegionGrid` abstract type has three subtypes:
2. `GeneralizedGrid` type, which is for the extraction of data on non-rectilinear lon-lat grids, such as a curvilinear grid.
3. `UnstructuredGrid` type, which is for the extraction of data on unstructured lon-lat grids such as a cubed-spherical grid, or an unstructured mesh.

Each of these types is in turn subdivided into **two** subtypes, (1) a `-Mask` type and (2) a `-Tilt` type. The `-Tilt` types are the same as the `-Mask` types, but with additional fields that specify the _rotation_ of fields.

More information can be found [here](/types)

```@docs
RectilinearGrid
GeneralizedGrid
UnstructuredGrid
```

Each of these types is in turn subdivided into **two** subtypes, (1) a `-Mask` type and (2) a `-Tilt` type. The `-Tilt` types are the same as the `-Mask` types, but with additional fields that specify the _rotation_ of fields.
```
30 changes: 30 additions & 0 deletions docs/src/types/index.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,30 @@
```@raw html
<script setup lang="ts">
import Gallery from "../components/Gallery.vue";
const types = [
{
href: "types/rectilinear",
src: "images/isin.png",
caption: "Rectilinear",
desc: "Rectilinear Lon/Lat Grids"
},
{
href: "types/generalized",
src: "images/ison.png",
caption: "Generalized",
desc: "Curvilinear or Nonlinear Lon/Lat Grids"
},
{
href: "types/unstructured",
src: "images/isequal.png",
caption: "Unstructured",
desc: "Unstructured Lon/Lat Grids and Meshes"
}
];
</script>
# Types of GeoRegions
<Gallery :images="types" />
```

0 comments on commit 23c7639

Please sign in to comment.