diff --git a/doc/interfaces/supercomputer_data/drafts/20231009_region_hierarchy/index.md b/doc/interfaces/supercomputer_data/drafts/20231009_region_hierarchy/index.md index 3df31b47..f945e6e9 100644 --- a/doc/interfaces/supercomputer_data/drafts/20231009_region_hierarchy/index.md +++ b/doc/interfaces/supercomputer_data/drafts/20231009_region_hierarchy/index.md @@ -69,10 +69,103 @@ Sub regions fall in to a hierarchy, for example one HUC2 has many HUC4s. ## Examples
-`region_hierarchy.json` -I believe this example doesn't quite fit with the specification outline above yet, it's -just an early draft. +`root_regions.json` +```{.json include="root_regions.json"} +``` +
+ +
+`region_26000.json` +```{.json include="region_26000.json"} +``` +
+ +
+`region_26101.json` +```{.json include="region_26101.json"} +``` +
+ +
+`region_hierarchy_26000.json` +```{.json include="region_hierarchy_26000.json"} +``` +
-```{.json include="regions.json"} +
+`region_hierarchy_26101.json` +```{.json include="region_hierarchy_26101.json"} ```
+ + +## Notes + +I feel that we'll need a dedicated specification for the categorization of regions. E.g. + +`region_category_26000.json` +```json +{ + "HUC2": {"long-name": "Hydrologic Unit Code (2-digit)"}, + "USSTATE": {"long-name": "U.S. State"} +} +``` + +and the hierarchy can define regions as members of categories instead of assigning +regions to categories as an attribute of a region. e.g.: + +`region_hierarchy_26000.json` +```json +{ + "HUC2": { + "children": { + "123123": { + "name": "HUC10", + "children": { + "HUC4": { + "234234": { + "name": "HUC1010", + "children": { + "HUC6": { + "345345": { + "name": "HUC101010" + }, + "345346": { + "name": "HUC101011" + }, + "345347": { + "name": "HUC101012" + } + } + } + }, + "234234": { + "name": "HUC1011", + "children": { + "HUC6": { + "445345": { + "name": "HUC101110" + }, + "445346": { + "name": "HUC101111" + }, + "445347": { + "name": "HUC101112" + } + } + } + } + } + } + } + } + } +} +``` + +Here, top-level keys and keys that are members of `children` dicts are collection +identifiers, e.g. `HUC2` corresponds to `Hydrologic Unit Code (2-digit)` from +`region_category_26000.json`. + +Perhaps instead of `children`, `items` is a more conventional name for members of a +collection? diff --git a/doc/interfaces/supercomputer_data/drafts/20231009_region_hierarchy/region_26000.json b/doc/interfaces/supercomputer_data/drafts/20231009_region_hierarchy/region_26000.json new file mode 100644 index 00000000..e8bcd663 --- /dev/null +++ b/doc/interfaces/supercomputer_data/drafts/20231009_region_hierarchy/region_26000.json @@ -0,0 +1,44 @@ +{ + "11725": { + "name": "California", + "code": "US-CA", + "subdivisionType": "adm1", + "shapefileRelativePath": "regionshapefiles/11/region_shapefile_11725.geojson" + }, + "11726": { + "name": "Colorado", + "code": "US-CO", + "subdivisionType": "adm1", + "shapefileRelativePath": "regionshapefiles/11/region_shapefile_11726.geojson" + }, + "12516": { + "name": "Pacific Northwest", + "code": "HUC17", + "subdivisionType": "huc2", + "shapefileRelativePath": "regionshapefiles/12/region_shapefile_12516.geojson" + }, + "12517": { + "name": "California", + "code": "HUC18", + "subdivisionType": "huc2", + "shapefileRelativePath": "regionshapefiles/12/region_shapefile_12517.geojson" + }, + "12807": { + "name": "Lower Columbia", + "code": "HUC1708", + "subdivisionType": "huc4", + "shapefileRelativePath": "regionshapefiles/12/region_shapefile_12807.geojson" + }, + "12809": { + "name": "Oregon-Washington Coastal", + "code": "HUC1710", + "subdivisionType": "huc4", + "shapefileRelativePath": "regionshapefiles/12/region_shapefile_12809.geojson" + }, + "12815": { + "name": "San Joaquin", + "code": "HUC1804", + "subdivisionType": "huc4", + "shapefileRelativePath": "regionshapefiles/12/region_shapefile_12815.geojson" + } +} \ No newline at end of file diff --git a/doc/interfaces/supercomputer_data/drafts/20231009_region_hierarchy/region_26101.json b/doc/interfaces/supercomputer_data/drafts/20231009_region_hierarchy/region_26101.json new file mode 100644 index 00000000..a111e86e --- /dev/null +++ b/doc/interfaces/supercomputer_data/drafts/20231009_region_hierarchy/region_26101.json @@ -0,0 +1,32 @@ +{ + "3701": { + "name": "Alberta", + "code": "CA-AB", + "subdivisionType": "adm1", + "shapefileRelativePath": "regionshapefiles/37/region_shapefile_3701.geojson" + }, + "24989": { + "name": "Catchment HYD78268", + "code": "HYD78268", + "subdivisionType": "hydro5", + "shapefileRelativePath": "regionshapefiles/24/region_shapefile_24989.geojson" + }, + "17376": { + "name": "Catchment HYD7821", + "code": "HYD7821", + "subdivisionType": "hydro4", + "shapefileRelativePath": "regionshapefiles/17/region_shapefile_17376.geojson" + }, + "17381": { + "name": "Catchment HYD7826", + "code": "HYD7826", + "subdivisionType": "hydro4", + "shapefileRelativePath": "regionshapefiles/17/region_shapefile_17381.geojson" + }, + "15269": { + "name": "Catchment HYD782", + "code": "HYD782", + "subdivisionType": "hydro3", + "shapefileRelativePath": "regionshapefiles/15/region_shapefile_15269.geojson" + } +} \ No newline at end of file diff --git a/doc/interfaces/supercomputer_data/drafts/20231009_region_hierarchy/region_hierarchy_26000.json b/doc/interfaces/supercomputer_data/drafts/20231009_region_hierarchy/region_hierarchy_26000.json new file mode 100644 index 00000000..c34ec472 --- /dev/null +++ b/doc/interfaces/supercomputer_data/drafts/20231009_region_hierarchy/region_hierarchy_26000.json @@ -0,0 +1,19 @@ +{ + "26000": { + "children": { + "11725": {}, + "11726": {}, + "12516": { + "children": { + "12807": {}, + "12809": {} + } + }, + "12517": { + "children": { + "12815": {} + } + } + } + } +} \ No newline at end of file diff --git a/doc/interfaces/supercomputer_data/drafts/20231009_region_hierarchy/region_hierarchy_26101.json b/doc/interfaces/supercomputer_data/drafts/20231009_region_hierarchy/region_hierarchy_26101.json new file mode 100644 index 00000000..48592c25 --- /dev/null +++ b/doc/interfaces/supercomputer_data/drafts/20231009_region_hierarchy/region_hierarchy_26101.json @@ -0,0 +1,71 @@ +{ + "26000": { + "children": { + "11725": {}, + "11726": {}, + "12516": { + "children": { + "12807": {}, + "12809": {} + } + }, + "12517": { + "children": { + "12815": {} + } + } + } + }, + "26004": { + "children": { + "26102": { + "children": { + "2684": {} + } + }, + "2044": { + "children": { + "3908": {} + } + }, + "15235": { + "children": { + "17138": { + "children": { + "24134": {} + } + } + } + } + } + }, + "26100": { + "children": { + "12518": { + "children": { + "12825": { + "children": { + "13355": {}, + "13368": {} + } + } + } + } + } + }, + "26101": { + "children": { + "3701": {}, + "15269": { + "children": { + "17376": {}, + "17381": { + "children": { + "24989": {} + } + } + } + } + } + } +} \ No newline at end of file diff --git a/doc/interfaces/supercomputer_data/drafts/20231009_region_hierarchy/regions.json b/doc/interfaces/supercomputer_data/drafts/20231009_region_hierarchy/regions.json deleted file mode 100644 index a6264fa8..00000000 --- a/doc/interfaces/supercomputer_data/drafts/20231009_region_hierarchy/regions.json +++ /dev/null @@ -1,263 +0,0 @@ -{ - "26000": { - "name": "Western United States", - "code": "USwest", - "subdivisionType": "adm0group", - "subregion_collections": { - "adm1": { - "name": "State / Country subdivision level 1", - "code": "adm1", - "items": { - "11725": { - "name": "California", - "code": "US-CA", - "subdivisionType": "adm1", - "subregion_collections": {} - }, - "11726": { - "name": "Colorado", - "code": "US-CO", - "subdivisionType": "adm1", - "subregion_collections": {} - } - } - }, - "huc2": { - "name": "U.S. Hydrologic Unit Code level 2", - "code": "huc2", - "items": { - "12516": { - "name": "Pacific Northwest", - "code": "HUC17", - "subdivisionType": "huc2", - "subregion_collections": { - "huc4": { - "name": "U.S. Hydrologic Unit Code level 4", - "code": "huc4", - "items": { - "12807": { - "name": "Lower Columbia", - "code": "HUC1708", - "subdivisionType": "huc4", - "subregion_collections": {} - }, - "12809": { - "name": "Oregon-Washington Coastal", - "code": "HUC1710", - "subdivisionType": "huc4", - "subregion_collections": {} - } - } - } - } - }, - "12517": { - "name": "California", - "code": "HUC18", - "subdivisionType": "huc2", - "subregion_collections": { - "huc4": { - "name": "U.S. Hydrologic Unit Code level 4", - "code": "huc4", - "items": { - "12815": { - "name": "San Joaquin", - "code": "HUC1804", - "subdivisionType": "huc4", - "subregion_collections": {} - } - } - } - } - } - } - } - } - }, - "26002": { - "name": "ASHimalayas", - "code": "ASHimalayas", - "subdivisionType": "adm0group", - "subregion_collections": {} - }, - "26004": { - "name": "AMAndes", - "code": "AMAndes", - "subdivisionType": "adm0group", - "subregion_collections": { - "adm0": { - "name": "Country", - "code": "adm0", - "items": { - "2044": { - "name": "Chile", - "code": "CHL", - "subdivisionType": "adm0", - "subregion_collections": { - "adm1": { - "name": "State / Country subdivision level 1", - "code": "adm1", - "items": { - "3908": { - "name": "Libertador General Bernardo O'Higgins", - "code": "CL-LI", - "subdivisionType": "adm1", - "subregion_collections": {} - } - } - } - } - } - } - }, - "hydro3": { - "name": "Hydrosheds level 3", - "code": "hydro3", - "items": { - "15235": { - "name": "South Chile coast", - "code": "HYD661", - "subdivisionType": "hydro3", - "subregion_collections": { - "hydro4": { - "name": "Hydrosheds level 4", - "code": "hydro4", - "items": { - "17138": { - "name": "Beagle channel", - "code": "HYD6610", - "subdivisionType": "hydro4", - "subregion_collections": { - "hydro5": { - "name": "Hydrosheds level 5", - "code": "hydro5", - "subregion_collections": { - "24134": { - "name": "", - "code": "HYD66100", - "subdivisionType": "hydro5" - } - } - } - } - } - } - } - } - } - } - } - } - }, - "26100": { - "name": "USAlaskaWAleutian", - "code": "USAlaskaWAleutian", - "subdivisionType": "adm1part", - "subregion_collections": { - "huc2": { - "name": "U.S. Hydrologic Unit Code level 2", - "code": "huc2", - "items": { - "12518": { - "name": "Alaska", - "code": "HUC19", - "subdivisionType": "huc2", - "subregion_collections": { - "huc4": { - "name": "U.S. Hydrologic Unit Code level 4", - "code": "huc4", - "items": { - "12825": { - "name": "Northwest Alaska", - "code": "HUC1905", - "subdivisionType": "huc4", - "subregion_collections": { - "huc6": { - "name": "U.S. Hydrologic Unit Code level 6", - "code": "huc6", - "subregion_collections": { - "13355": { - "name": "Kobuk-Selawik Rivers", - "code": "HUC190503", - "subdivisionType": "huc6" - }, - "13368": { - "name": "Norton Sound", - "code": "HUC190501", - "subdivisionType": "huc6" - } - } - } - } - } - } - } - } - } - } - } - } - }, - "26101": { - "name": "AMCanadaW", - "code": "AMCanadaW", - "subdivisionType": "adm0part", - "subregion_collections": { - "adm1": { - "name": "State / Country subdivision level 1", - "code": "adm1", - "items": { - "3701": { - "name": "Alberta", - "code": "CA-AB", - "subdivisionType": "adm1", - "subregion_collections": {} - } - } - }, - "hydro3": { - "name": "Hydrosheds level 3", - "code": "hydro3", - "items": { - "15269": { - "name": "", - "code": "HYD782", - "subdivisionType": "hydro3", - "subregion_collections": { - "hydro4": { - "name": "Hydrosheds level 4", - "code": "hydro4", - "items": { - "17376": { - "name": "", - "code": "HYD7821", - "subdivisionType": "hydro4", - "subregion_collections": {} - }, - "17381": { - "name": "", - "code": "HYD7826", - "subdivisionType": "hydro4", - "subregion_collections": { - "hydro5": { - "name": "Hydrosheds level 5", - "code": "hydro5", - "subregion_collections": { - "24989": { - "name": "", - "code": "HYD78268", - "subdivisionType": "hydro5" - } - } - } - } - } - } - } - } - } - } - } - } - } -} diff --git a/doc/interfaces/supercomputer_data/drafts/20231009_region_hierarchy/regions_26000.json b/doc/interfaces/supercomputer_data/drafts/20231009_region_hierarchy/regions_26000.json deleted file mode 100644 index 1d22b6f7..00000000 --- a/doc/interfaces/supercomputer_data/drafts/20231009_region_hierarchy/regions_26000.json +++ /dev/null @@ -1,37 +0,0 @@ -{ - "11725": { - "name": "California", - "code": "US-CA", - "subdivisionType": "adm1" - }, - "11726": { - "name": "Colorado", - "code": "US-CO", - "subdivisionType": "adm1" - }, - "12516": { - "name": "Pacific Northwest", - "code": "HUC17", - "subdivisionType": "huc2" - }, - "12517": { - "name": "California", - "code": "HUC18", - "subdivisionType": "huc2" - }, - "12807": { - "name": "Lower Columbia", - "code": "HUC1708", - "subdivisionType": "huc4" - }, - "12809": { - "name": "Oregon-Washington Coastal", - "code": "HUC1710", - "subdivisionType": "huc4" - }, - "12815": { - "name": "San Joaquin", - "code": "HUC1804", - "subdivisionType": "huc4" - } -} \ No newline at end of file diff --git a/doc/interfaces/supercomputer_data/drafts/20231009_region_hierarchy/regions_26101.json b/doc/interfaces/supercomputer_data/drafts/20231009_region_hierarchy/regions_26101.json deleted file mode 100644 index 0d17c1b0..00000000 --- a/doc/interfaces/supercomputer_data/drafts/20231009_region_hierarchy/regions_26101.json +++ /dev/null @@ -1,27 +0,0 @@ -{ - "3701": { - "name": "Alberta", - "code": "CA-AB", - "subdivisionType": "adm1" - }, - "24989": { - "name": "Catchment HYD78268", - "code": "HYD78268", - "subdivisionType": "hydro5" - }, - "17376": { - "name": "Catchment HYD7821", - "code": "HYD7821", - "subdivisionType": "hydro4" - }, - "17381": { - "name": "Catchment HYD7826", - "code": "HYD7826", - "subdivisionType": "hydro4" - }, - "15269": { - "name": "Catchment HYD782", - "code": "HYD782", - "subdivisionType": "hydro3" - } -} \ No newline at end of file diff --git a/doc/interfaces/supercomputer_data/drafts/20231009_region_hierarchy/root_regions.json b/doc/interfaces/supercomputer_data/drafts/20231009_region_hierarchy/root_regions.json index d917771e..347cdfc9 100644 --- a/doc/interfaces/supercomputer_data/drafts/20231009_region_hierarchy/root_regions.json +++ b/doc/interfaces/supercomputer_data/drafts/20231009_region_hierarchy/root_regions.json @@ -3,35 +3,45 @@ "name": "Western United States", "code": "USwest", "subdivisionType": "adm0group", - "EPSG": 3857, - "subdivisionListAndMetadataRelativePath": "subdivisionlist/subdivisionlist_26000.json" + "CRS": "EPSG:3857", + "subdivisionListAndMetadataRelativePath": "regionlist/region_list_26000.json", + "subdivisionHierarchyRelativePath": "regionhierarchy/region_hierarchy_26000.json", + "shapefileRelativePath": "regionshapefiles/26/region_shapefile_26000.geojson" }, "26002": { "name": "ASHimalayas", "code": "ASHimalayas", "subdivisionType": "adm0group", - "EPSG": 0, - "subdivisionListAndMetadataRelativePath": "subdivisionlist/subdivisionlist_26002.json" + "CRS": "", + "subdivisionListAndMetadataRelativePath": "regionlist/region_list_26002.json", + "subdivisionHierarchyRelativePath": "regionhierarchy/region_hierarchy_26002.json", + "shapefileRelativePath": "regionshapefiles/26/region_shapefile_26002.geojson" }, "26004": { "name": "AMAndes", "code": "AMAndes", "subdivisionType": "adm0group", - "EPSG": 0, - "subdivisionListAndMetadataRelativePath": "subdivisionlist/subdivisionlist_26004.json" + "CRS": "", + "subdivisionListAndMetadataRelativePath": "regionlist/region_list_26004.json", + "subdivisionHierarchyRelativePath": "regionhierarchy/region_hierarchy_26004.json", + "shapefileRelativePath": "regionshapefiles/26/region_shapefile_26004.geojson" }, "26100": { "name": "USAlaskaWAleutian", "code": "USAlaskaWAleutian", "subdivisionType": "adm1part", - "EPSG": 0, - "subdivisionListAndMetadataRelativePath": "subdivisionlist/subdivisionlist_26100.json" + "CRS": "", + "subdivisionListAndMetadataRelativePath": "regionlist/region_list_26100.json", + "subdivisionHierarchyRelativePath": "regionhierarchy/region_hierarchy_26100.json", + "shapefileRelativePath": "regionshapefiles/26/region_shapefile_26100.geojson" }, "26101": { "name": "AMCanadaW", "code": "AMCanadaW", "subdivisionType": "adm0part", - "EPSG": 0, - "subdivisionListAndMetadataRelativePath": "subdivisionlist/subdivisionlist_26101.json" + "CRS": "", + "subdivisionListAndMetadataRelativePath": "regionlist/region_list_26101.json", + "subdivisionHierarchyRelativePath": "regionhierarchy/region_hierarchy_26101.json", + "shapefileRelativePath": "regionshapefiles/26/region_shapefile_26101.geojson" } } \ No newline at end of file