pygeoapi.config.yml

#
# LAST UPDATE: 2025-02-11 15:25:00-5
#=================================================================
#
# Authors: Benjamin Webb <bwebb@lincolninst.edu
#
# Copyright (c) 2025 Ben Webb
#
# Permission is hereby granted, free of charge, to any person
# obtaining a copy of this software and associated documentation
# files (the "Software"), to deal in the Software without
# restriction, including without limitation the rights to use,
# copy, modify, merge, publish, distribute, sublicense, and/or sell
# copies of the Software, and to permit persons to whom the
# Software is furnished to do so, subject to the following
# conditions:
#
# The above copyright notice and this permission notice shall be
# included in all copies or substantial portions of the Software.
#
# THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
# EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES
# OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
# NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT
# HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY,
# WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING
# FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR
# OTHER DEALINGS IN THE SOFTWARE.
#
# =================================================================

data_link: &data-link
  type: text/html
  rel: canonical
  title: data source
  hreflang: en-US

provider_defaults: &provider_defaults
  type: feature
  name: pygeoapi_plugins.provider.sparql.SPARQLProvider
  sparql_provider: PostgreSQL
  data:
    host: ${POSTGRES_HOST}
    dbname: ${POSTGRES_DB}
    user: ${POSTGRES_USER}
    password: ${POSTGRES_PASSWORD}
  id_field: id
  title_field: name
  uri_field: uri
  geom_field: geom

sparql_query: &sparql_query
  convert: false
  endpoint: https://graph.geoconnex.us/repositories/iow
  prefixes:
    schema: <https://schema.org/>
    gsp: <http://www.opengis.net/ont/geosparql#>
    wiki: <https://www.wikidata.org/wiki/>
    hyf: <https://www.opengis.net/def/schema/hy_features/hyf/>
    xsd: <http://www.w3.org/2001/XMLSchema#>

huc_sparql_query: &huc_sparql_query
  <<: *sparql_query
  bind:
    name: uri
    variable: "?huc"
  select: '?huc ?hucLevel (GROUP_CONCAT(?containedCatchment; SEPARATOR="|") AS ?hucs)'
  groupby: "?huc ?hucLevel"
  where:
    - subject: "?containedCatchment"
      predicate: hyf:containingCatchment
      object: "?huc"
  filter:
    - 'BIND(REPLACE(STR(?containedCatchment), "^.*ref/(hu[0-9]+)/.*$", "$1") AS ?hucLevel)'

tile_defaults: &tile_defaults
  type: tile
  name: MVT-tippecanoe
  options:
    zoom:
      min: 0
      max: 10
  format:
    name: pbf
    mimetype: application/vnd.mapbox-vector-tile

server:
  bind:
    host: localhost #change to your hostname if running your own instance
    port: 5000
  url: ${PYGEOAPI_URL} #change to host URL  if running your own instance
  mimetype: application/json; charset=UTF-8
  encoding: utf-8
  gzip: false
  language: en-US
  cors: true
  pretty_print: true
  limits:
    default_items: 500
    max_items: 10000
  map:
    url: https://tile.openstreetmap.org/{z}/{x}/{y}.png
    attribution: '<a href="https://www.openstreetmap.org/copyright">© OpenStreetMap contributors</a>'
  templates:
    path: /skin-dashboard/templates
    static: /skin-dashboard/static

logging:
  level: ERROR
  # logfile: /tmp/pygeoapi.log

metadata:
  identification:
    title: Geoconnex Reference Service
    description: Provides reference for community features in geoconnex.us
    keywords:
      - Geospatial
      - Geoconnex
      - Reference
    keywords_type: theme
    terms_of_service: https://creativecommons.org/licenses/by/4.0/
    url: https://github.com/internetofwater/reference.geoconnex.us
  license:
    name: CC-BY 4.0 license
    url: https://creativecommons.org/licenses/by/4.0/
  provider:
    name: Center for Geospatial Solutions
    url: https://cgsearth.org/
  contact:
    address: 113 Brattle St
    city: Cambridge
    stateorprovince: Massachussetts
    postalcode: 02138
    country: USA
    email: internetofwater@lincolninst.edu
    url: https://internetofwater.org
    role: pointOfContact
    name: Benjamin Webb

resources:
  hu02:
    type: collection
    title: HU02
    description: Two-digit Hydrologic Regions from USGS NHDPlus High Resolution
    keywords:
      - Hydrologic Regions
      - USGS
    linked-data:
      context:
        - schema: https://schema.org/
          name: schema:name
          gnis_url:
            "@id": schema:subjectOf
            "@type": "@id"
    links:
      - <<: *data-link
        href: https://www.usgs.gov/core-science-systems/ngp/national-hydrography/access-national-hydrography-products
    extents: &extents
      spatial:
        bbox: [-170, 15, -51, 72]
        crs: http://www.opengis.net/def/crs/OGC/1.3/CRS84
      temporal:
        begin: null
        end: null
    providers:
      - <<: *provider_defaults
        id_field: huc2
        table: hu02
        sparql_query: *huc_sparql_query
      - <<: *tile_defaults
        data: ${TILES_PATH}/hu02/${TILES_SUFFIX:-}
  hu04:
    type: collection
    title: HU04
    description: Four-digit Hydrologic Subregion from USGS NHDPlus High Resolution
    keywords:
      - Hydrologic Subregions
      - USGS
    linked-data:
      item_template: jsonld/hu04.jsonld
    links:
      - <<: *data-link
        href: https://www.usgs.gov/core-science-systems/ngp/national-hydrography/access-national-hydrography-products
    extents: *extents
    providers:
      - <<: *provider_defaults
        id_field: huc4
        table: hu04
        sparql_query: *huc_sparql_query
      - <<: *tile_defaults
        data: ${TILES_PATH}/hu04/${TILES_SUFFIX:-}
  hu06:
    type: collection
    title: HU06
    description: Six-digit Hydrologic Basins from USGS NHDPlus High Resolution
    keywords:
      - Hydrologic Basins
      - USGS
    linked-data:
      item_template: jsonld/hu06.jsonld
    links:
      - <<: *data-link
        href: https://www.usgs.gov/core-science-systems/ngp/national-hydrography/access-national-hydrography-products
    extents: *extents
    providers:
      - <<: *provider_defaults
        id_field: huc6
        table: hu06
        sparql_query: *huc_sparql_query
      - <<: *tile_defaults
        data: ${TILES_PATH}/hu06/${TILES_SUFFIX:-}
  hu08:
    type: collection
    title: HU08
    description: Eight-digit Hydrologic Subbasins from USGS NHDPlus High Resolution
    keywords:
      - Hydrologic Subbasins
      - USGS
    linked-data:
      item_template: jsonld/hu08.jsonld
    links:
      - <<: *data-link
        href: https://www.usgs.gov/core-science-systems/ngp/national-hydrography/access-national-hydrography-products
    extents: *extents
    providers:
      - <<: *provider_defaults
        id_field: huc8
        table: hu08
        sparql_query:
          <<: *huc_sparql_query
          select: '?huc (GROUP_CONCAT(?containedCatchment; SEPARATOR="|") AS ?hucs)'
      - <<: *tile_defaults
        data: ${TILES_PATH}/hu08/${TILES_SUFFIX:-}
  hu10:
    type: collection
    title: HU10
    description: Ten-digit Watersheds from USGS NHDPlus High Resolution
    keywords:
      - Watersheds
      - USGS
    linked-data:
      item_template: jsonld/hu10.jsonld
    links:
      - <<: *data-link
        href: https://www.usgs.gov/core-science-systems/ngp/national-hydrography/access-national-hydrography-products
    extents: *extents
    providers:
      - <<: *provider_defaults
        name: PostgreSQL
        id_field: huc10
        table: hu10
      - <<: *tile_defaults
        data: ${TILES_PATH}/hu10/${TILES_SUFFIX:-}
  nat_aq:
    type: collection
    title: USGS National Aquifers
    description: National Aquifers of the United States from USGS National Water Information System National Aquifer code list
    keywords:
      - National Aquifers
      - USGS
    linked-data:
      context:
        - schema: https://schema.org/
          aq_name: schema:name
          link:
            "@id": schema:subjectOf
            "@type": "@id"
          sameas:
            "@id": schema:sameAs
            "@type": "@id"
    links:
      - <<: *data-link
        href: https://cida.usgs.gov/ngwmn/
      - <<: *data-link
        title: code list with links
        href: https://water.usgs.gov/ogw/NatlAqCode-reflist.html
    extents:
      spatial:
        bbox: [-160, 18, -64, 50]
        crs: http://www.opengis.net/def/crs/OGC/1.3/CRS84
      temporal:
        begin: null
        end: null
    providers:
      - <<: *provider_defaults
        name: PostgreSQL
        id_field: nat_aqfr_cd
        title_field: aq_name
        table: nat_aq
  principal_aq:
    type: collection
    title: USGS Principal Aquifers
    description: Principal Aquifers of the United States from 2003 USGS data release
    keywords:
      - Principal Aquifers
      - USGS
    linked-data:
      context:
        - schema: https://schema.org/
          aq_name: schema:name
          sameas:
            "@id": schema:sameAs
            "@type": "@id"
    links:
      - <<: *data-link
        href: https://water.usgs.gov/GIS/metadata/usgswrd/XML/aquifers_us.xml
    extents:
      spatial:
        bbox: [-160, 18, -64, 50]
        crs: http://www.opengis.net/def/crs/OGC/1.3/CRS84
      temporal:
        begin: null
        end: null
    providers:
      - <<: *provider_defaults
        name: PostgreSQL
        id_field: aq_code
        title_field: aq_name
        table: princi_aq
  sec_hydrg_reg:
    type: collection
    title: USGS Secondary Hydrogeologic Regions
    description: Secondary Hydrogeologic Regions of the Conterminous United States from 2018 USGS data release
    keywords:
      - Hydrogeologic Regions
      - USGS
    linked-data:
      context:
        - schema: https://schema.org/
          shr: schema:name
    links:
      - <<: *data-link
        href: https://doi.org/10.5066/F7F76BSS
        hreflang: en-US
      - <<: *data-link
        title: report documenting data
        href: https://doi.org/10.1111/gwat.12806
    extents:
      spatial:
        bbox: [-125, 26, -66, 50]
        crs: http://www.opengis.net/def/crs/OGC/1.3/CRS84
      temporal:
        begin: null
        end: null
    providers:
      - <<: *provider_defaults
        name: PostgreSQL
        id_field: id
        title_field: shr
        table: sec_hydrg_reg
  gages: # updated 2024-10-08
    type: collection
    title: Reference Gages
    description: United States community contributed reference Stream Gage Monitoring Locations
    keywords:
      - Stream Gages
      - USGS
    linked-data:
      item_template: jsonld/ref-gages.jsonld
    links:
      - <<: *data-link
        href: https://github.com/internetofwater/ref_gages
    extents: *extents
    providers:
      - <<: *provider_defaults
        name: PostgreSQL
        title_field: description
        table: ref_gages
  mainstems:
    type: collection
    title: Reference Mainstems
    description: United States community contributed reference Mainstem Rivers
    keywords:
      - Mainstem
      - Community
    linked-data:
      item_template: jsonld/mainstems.jsonld
      context:
        - schema: https://schema.org/
          name_at_outlet: schema:name
    links:
      - <<: *data-link
        href: https://github.com/internetofwater/ref_rivers
    extents: *extents
    providers:
      - <<: *provider_defaults
        title_field: name_at_outlet
        table: mainstems
        sparql_query:
          <<: *sparql_query
          bind:
            name: uri
            variable: "?mainstem"
          select: "?mainstem ?monitoringLocation ?siteName ?datasetDescription ?type ?url ?variableMeasured ?variableUnit ?measurementTechnique ?temporalCoverage ?distributionName ?distributionURL ?distributionFormat ?wkt"
          where:
            - "?monitoringLocation hyf:HydroLocationType ?type"
            - "?monitoringLocation hyf:referencedPosition/hyf:HY_IndirectPosition/hyf:linearElement ?mainstem"
            - "?monitoringLocation schema:subjectOf ?dataset"
            - "?monitoringLocation gsp:hasGeometry/gsp:asWKT ?wkt"
            - "?dataset schema:variableMeasured ?var"
            - "?dataset schema:url ?url"
            - "?dataset schema:distribution ?distribution"
            - "?dataset schema:description ?datasetDescription"
            - "?dataset schema:temporalCoverage ?temporalCoverage"
            - "?dataset schema:name ?siteName"
            - "?var schema:name ?variableMeasured"
            - "?var schema:unitText ?variableUnit"
            - "?var schema:measurementTechnique ?measurementTechnique"
            - "?distribution schema:name ?distributionName"
            - "?distribution schema:contentUrl ?distributionURL"
            - "?distribution schema:encodingFormat ?distributionFormat"
      - <<: *tile_defaults
        data: ${TILES_PATH}/mainstems/${TILES_SUFFIX:-}
  dams: # updated 2024-04-23
    type: collection
    title: Reference Dams
    description: United States Community Contributed Reference Dams
    keywords:
      - Dams
      - Community
    linked-data:
      context:
        - schema: https://schema.org/
          name: schema:name
          description: schema:description
          provider:
            "@id": schema:provider
            "@type": schema:url
          subjectOf:
            "@id": schema:subjectOf
            "@type": schema:url
    links:
      - <<: *data-link
        href: https://github.com/internetofwater/ref_dams
    extents: *extents
    providers:
      - <<: *provider_defaults
        name: PostgreSQL
        title_field: description
        table: ref_dams
  pws: #updated 2024-07-02
    type: collection
    title: Public Water Systems
    description: Public Water Systems from United States EPA Safe Drinking Water Information System
    keywords:
      - Public Water Systems
      - EPA
    linked-data:
      context:
        - pws_name: https://schema.org/name
        - state_uri: https://schema.org/geoWithin
        - sdwis_link: https://schema.org/subjectOf
        - source_url: https://schema.org/isBasedOn
        - place_uri: https://schema.org/geoIntersects
        - schema: https://schema.org/
          sdwis_link:
            "@id": schema:subjectOf
            "@type": "@id"
          source_url:
            "@id": schema:isBasedOn
            "@type": "@id"
          state_uri:
            "@id": schema:geoWithin
            "@type": "@id"
          place_link:
            "@id": schema:geoIntersects
            "@type": "@id"
    links:
      - <<: *data-link
        title: EPA PWSID List source
        href: https://echo.epa.gov/tools/data-downloads/sdwa-download-summary
      - <<: *data-link
        title: geographic data source
        href: https://github.com/cgs-earth/ref_pws
    extents: *extents
    providers:
      - <<: *provider_defaults
        name: PostgreSQL
        id_field: pwsid
        title_field: pws_name
        table: ref_pws
      - <<: *tile_defaults
        data: ${TILES_PATH}/pws/${TILES_SUFFIX:-}
  states:
    type: collection
    title: States
    description: States from United States Census Bureau Cartographic Boundaries
    keywords:
      - States
      - Census
    linked-data:
      context:
        - schema: https://schema.org/
          name: schema:name
          census_profile:
            "@id": schema:subjectOf
            "@type": "@id"
    links:
      - <<: *data-link
        title: geographic data source
        href: https://www.census.gov/geographies/mapping-files/time-series/geo/cartographic-boundary.html
      - <<: *data-link
        title: Census data source
        href: https://data.census.gov/cedsci
    extents: *extents
    providers:
      - <<: *provider_defaults
        name: PostgreSQL
        id_field: geoid
        table: states
  counties:
    type: collection
    title: Counties
    description: Counties from United States Census Bureau Cartographic Boundaries
    keywords:
      - Counties
      - Census
    linked-data:
      item_template: jsonld/counties.jsonld
      context:
        - schema: https://schema.org/
          name: schema:name
          census_profile:
            "@id": schema:subjectOf
            "@type": "@id"
    links:
      - <<: *data-link
        title: geographic data source
        href: https://www.census.gov/geographies/mapping-files/time-series/geo/cartographic-boundary.html
      - <<: *data-link
        title: Census data source
        href: https://data.census.gov/cedsci
    extents: *extents
    providers:
      - <<: *provider_defaults
        name: PostgreSQL
        id_field: geoid
        table: counties
      - <<: *tile_defaults
        data: ${TILES_PATH}/counties/${TILES_SUFFIX:-}
  aiannh:
    type: collection
    title: American Indian/Alaska Native Areas/Hawaiian Home Lands (AIANNH)
    description: Federally recognized American Indian/Alaska Native Areas/Hawaiian Home Lands (AIANNH)
    keywords:
      - American Indian Areas
      - Alaska Native Areas
      - Hawaiian Home Lands
      - Census
    linked-data:
      context:
        - name: https://schema.org/name
    links:
      - <<: *data-link
        title: geographic data source
        href: https://www.census.gov/geographies/mapping-files/time-series/geo/cartographic-boundary.html
    extents: *extents
    providers:
      - <<: *provider_defaults
        name: PostgreSQL
        id_field: geoid
        table: aiannh
  cbsa:
    type: collection
    title: Core-based statistical areas (CBSA)
    description: United States Metropolitan and Micropolitan Statistical Areas
    keywords:
      - Core-based statistical areas
      - Metropolitan Statistical Areas
      - Micropolitan Statistical Areas
      - Census
    linked-data:
      context:
        - name: https://schema.org/name
    links:
      - <<: *data-link
        title: geographic data source
        href: https://www.census.gov/geographies/mapping-files/time-series/geo/cartographic-boundary.html
    extents: *extents
    providers:
      - <<: *provider_defaults
        name: PostgreSQL
        id_field: geoid
        table: cbsa
  ua10:
    type: collection
    title: Urban Areas
    description: United States Urbanized Areas and Urban Clusters from the 2010 Census
    keywords:
      - Urban Areas
      - Census
    linked-data:
      context:
        - name10: https://schema.org/name
    links:
      - <<: *data-link
        title: geographic data source
        href: https://www.census.gov/geographies/mapping-files/time-series/geo/cartographic-boundary.html
      - <<: *data-link
        title: descriptive data source
        href: https://www.census.gov/programs-surveys/geography/guidance/geo-areas/urban-rural/2010-urban-rural.html
    extents: *extents
    providers:
      - <<: *provider_defaults
        name: PostgreSQL
        id_field: geoid10
        title_field: name10
        table: ua10
  places:
    type: collection
    title: Places
    description: United States legally incorporated and Census designated places
    keywords:
      - Places
      - Census
    linked-data:
      context:
        - schema: https://schema.org/
          name: schema:name
          census_profile:
            "@id": schema:subjectOf
            "@type": "@id"
    links:
      - <<: *data-link
        title: geographic data source
        href: https://www.census.gov/geographies/mapping-files/time-series/geo/cartographic-boundary.html
      - <<: *data-link
        title: Census data source
        href: https://data.census.gov/cedsci
    extents: *extents
    providers:
      - <<: *provider_defaults
        name: PostgreSQL
        id_field: geoid
        table: places
  intersector:
    type: process
    processor:
      name: pygeoapi_plugins.process.intersect.IntersectionProcessor
  sitemap:
    type: stac-collection
    title: sitemap
    description: geoconnex.us sitemap
    keywords:
      - Geoconnex
      - Sitemap
      - Internet of Water
    links:
      - <<: *data-link
        title: information
        href: https://geoconnex.us
      - <<: *data-link
        title: sitemap
        href: https://geoconnex.us/sitemap.xml
    extents:
      spatial:
        bbox: [-180, -90, 180, 90]
        crs: http://www.opengis.net/def/crs/OGC/1.3/CRS84
    providers:
      - type: stac
        name: FileSystem
        data: /sitemap
        file_types:
          - .xml