Skip to content

Commit

Permalink
fixes
Browse files Browse the repository at this point in the history
  • Loading branch information
ibgreen committed Oct 13, 2023
1 parent ac142d2 commit f56369a
Show file tree
Hide file tree
Showing 5 changed files with 15 additions and 15 deletions.
8 changes: 4 additions & 4 deletions docs/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -9,7 +9,7 @@ While math.gl is highly **optimized for use with the WebGL and WebGPU APIs**, it
- **3D math** - Basic vectors and matrices, as well as 3D primitives and culling: **`@math.gl/types`**, **`@math.gl/core`**, **`@math.gl/culling`**
- **Geospatial projections** - Support for a variety of geospatial projections **`@math.gl/geospatial`**, **`@math.gl/geoid`**, **`@math.gl/proj4`**, **`@math.gl/web-mercator`**
- **Geospatial utilities** - Cutting polygons and calculating sun position and direction **`@math.gl/polygon`**, **`@math.gl/sun`**
- **Discrete Global Grids** - Standardized interfaces to a number of the major discrete global grids. **`@math.gl/geohash`**, **`@math.gl/quadkey`**, **`@math.gl/s2`**
- **Discrete Global Grids** - Standardized interfaces to a number of the major discrete global grids. **`@math.gl/dggs-geohash`**, **`@math.gl/dggs-quadkey`**, **`@math.gl/dggs-s2`**

## Modules

Expand All @@ -33,9 +33,9 @@ math.gl is a toolbox that offers a suite of composable modules.
| **DGGS (Discrete global grid support) libraries** | Module <span style={{width: 300}} /> | Description |
| ------------------------------------------------- | ------------------------------------ | ------------------------------- |
| | | |
| ![geohash](./images/dggs/geohash.png 'geohash') | **`@math.gl/geohash`** | Get geometry of GeoHash tokens. |
| ![quadkey](./images/dggs/quadkey.png 'quadkey') | **`@math.gl/quadkey`** | Get geometry of QuadKey tokens |
| ![s2](./images/dggs/s2.png 's2') | **`@math.gl/s2`** | Get geometry of S2 tokens. |
| ![geohash](./images/dggs/geohash.png 'geohash') | **`@math.gl/dggs-geohash`** | Get geometry of GeoHash tokens. |
| ![quadkey](./images/dggs/quadkey.png 'quadkey') | **`@math.gl/dggs-quadkey`** | Get geometry of QuadKey tokens |
| ![s2](./images/dggs/s2.png 's2') | **`@math.gl/dggs-s2`** | Get geometry of S2 tokens. |

<br/>
In addition, math.gl provides a few deprecated legacy modules, to avoid breaking older applications.
Expand Down
12 changes: 6 additions & 6 deletions docs/developer-guide/geospatial/dggs.md
Original file line number Diff line number Diff line change
Expand Up @@ -14,12 +14,12 @@ In terms of API design and nomenclature, the golden standard for DGGS systems at

## Supported Grid Systems

| DGGS | Module | Functionality |
| ----------------------------------------------- | ------------------ | ------------------------------- |
| ![GeoHash](../../images/dggs/geohash.png 'GeoHash') | `@math.gl/geohash` | Get geometry of GeoHash tokens. |
| ![QuadKey](../../images/dggs/quadkey.png 'QuadKey') | `@math.gl/quadkey` | Get geometry of QuadKey tokens |
| ![S2](../../images/dggs/s2.png 'S2') | `@math.gl/s2` | Get geometry of S2 tokens. |
| ![H3](../../images/dggs/h3.png 'H3') | `h3-js` \* | Get geometry of H3 tokens. |
| DGGS | Module | Functionality |
| --------------------------------------------------- | ----------------------- | ------------------------------- |
| ![GeoHash](../../images/dggs/geohash.png 'GeoHash') | `@math.gl/dggs-geohash` | Get geometry of GeoHash tokens. |
| ![QuadKey](../../images/dggs/quadkey.png 'QuadKey') | `@math.gl/dggs-quadkey` | Get geometry of QuadKey tokens |
| ![S2](../../images/dggs/s2.png 'S2') | `@math.gl/dggs-s2` | Get geometry of S2 tokens. |
| ![H3](../../images/dggs/h3.png 'H3') | `h3-js` \* | Get geometry of H3 tokens. |

Note that `h3-js` is not a `math.gl` library. For H3 it is recommended to work directly with the H3 JavaScript bindings.

Expand Down
2 changes: 1 addition & 1 deletion modules/dggs-s2/README.md
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
# @math.gl/s2
# @math.gl/dggs-s2

[math.gl](https://math.gl/docs) is a suite of math modules for 3D and geospatial applications.

Expand Down
2 changes: 1 addition & 1 deletion modules/dggs-s2/test/s2-geometry.spec.ts
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@

import test from 'tape-promise/tape';

import {_toHilbertQuadKey as toHilbertQuadKey} from '@math.gl/s2';
import {_toHilbertQuadKey as toHilbertQuadKey} from '@math.gl/dggs-s2';
import {S2} from 's2-geometry';
import Long from 'long';

Expand Down
6 changes: 3 additions & 3 deletions website/docusaurus.config.js
Original file line number Diff line number Diff line change
Expand Up @@ -59,9 +59,9 @@ const config = {
'@math.gl/proj4': resolve('../modules/proj4/src'),
'@math.gl/web-mercator': resolve('../modules/web-mercator/src'),
'@math.gl/sun': resolve('../modules/sun/src'),
'@math.gl/geohash': resolve('../modules/mapbox/geohash'),
'@math.gl/quadkey': resolve('../modules/quadkey/src'),
'@math.gl/s2': resolve('../modules/s2/src'),
'@math.gl/ddgs-geohash': resolve('../modules/ddgs-geohash/src'),
'@math.gl/dggs-quadkey': resolve('../modules/dggs-quadkey/src'),
'@math.gl/dggs-s2': resolve('../modules/dggs-s2/src'),

'@probe.gl/bench': resolve('../node_modules/@probe.gl/bench')
}
Expand Down

0 comments on commit f56369a

Please sign in to comment.