docs(custom-pu-grid): initial hld

Vizzuality · Sep 7, 2021 · cf7f3a4 · cf7f3a4
1 parent 3cd3fd2
commit cf7f3a4
Show file tree

Hide file tree

Showing 12 changed files with 25 additions and 0 deletions.
diff --git a/api/apps/geoprocessing/src/modules/planning-units-grid/index.ts b/api/apps/geoprocessing/src/modules/planning-units-grid/index.ts
diff --git a/api/apps/geoprocessing/src/modules/planning-units-grid/planning-units-grid.module.ts b/api/apps/geoprocessing/src/modules/planning-units-grid/planning-units-grid.module.ts
diff --git a/api/apps/geoprocessing/src/modules/planning-units-grid/planning-units-grid.processor.ts b/api/apps/geoprocessing/src/modules/planning-units-grid/planning-units-grid.processor.ts
diff --git a/api/apps/geoprocessing/test/integration/planning-unit-grid/nam-shapefile.zip b/api/apps/geoprocessing/test/integration/planning-unit-grid/nam-shapefile.zip
diff --git a/api/apps/geoprocessing/test/integration/planning-unit-grid/nam.geojson b/api/apps/geoprocessing/test/integration/planning-unit-grid/nam.geojson
diff --git a/api/apps/geoprocessing/test/integration/planning-unit-grid/planning-units-grid.e2e-spec.ts b/api/apps/geoprocessing/test/integration/planning-unit-grid/planning-units-grid.e2e-spec.ts
diff --git a/api/apps/geoprocessing/test/integration/planning-unit-grid/planning-units-grid.fixtures.ts b/api/apps/geoprocessing/test/integration/planning-unit-grid/planning-units-grid.fixtures.ts
diff --git a/api/libs/planning-units-grid/src/job-input.ts b/api/libs/planning-units-grid/src/job-input.ts
diff --git a/api/libs/planning-units-grid/src/job-output.ts b/api/libs/planning-units-grid/src/job-output.ts
diff --git a/api/libs/planning-units-grid/src/queue-name.ts b/api/libs/planning-units-grid/src/queue-name.ts
diff --git a/docs/custom-planning-unit-geometry.hld.md b/docs/custom-planning-unit-geometry.hld.md
@@ -0,0 +1,17 @@
+# Goal
+
+Users may sometimes create their own planning unit geometries, instead of
+relying on generated square or hexagonal grids, for a variety of conservation
+reasons, so they should be able to supply their own PU grid via a shapefile
+upload.
+
+# Key assumptions
+
+* once set, shape cannot be changed or removed from project
+* only `FeatureCollection` with `Polygon` features can be uploaded
+* custom planning unit grid geometry belongs to given project
+* custom planning unit grid geometry has a type of `irregular`
+* project with custom planning unit grid geometry cannot use other shape types
+* uploaded shapefile will be processed asynchronously
+* until processed, any action on project/underlying scenarios shouldn't be
+  allowed
diff --git a/docs/custom-planning-unit-geometry.lld.md b/docs/custom-planning-unit-geometry.lld.md
@@ -0,0 +1,8 @@
+# Sending shapefile
+
+// TODO: curl
+
+# Getting status of the processing
+
+// TODO: curl
+