/ref_pws

A repository to manage the updating of the EPIC/SimpleLab water service boundaries layer with moderated community contributions

Primary LanguageRMIT LicenseMIT

ref_pws: Reference Public Water Systems (PWS) for geoconnex.us

A repository to manage the creation of a reference feature set of best available boundaries for public water systems (as identified but not spatially defined in the USEPA Safe Drinking Water Information System) in the United States with moderated community contributions. For now, the base layer will be the latest national dataset created by SimpleLab Inc, which is hosted on Hydroshare. Community contributions to this repository are added to this layer, which is then updated with some value added attributes.

How it works

This repository includes state-based contribution/{state-code} directories where community members may submit .geojson files associated with each individual contributed boundary. To create a reproducible workflow a docker image includes runner.R that

  1. iterates through the contribution folders and .geojson files, reading and combining the contributions
  2. exports the layer to a GeoPackage named contributed_pws.gpkg and updates the corresponding file on a dedicated Hydroshare resource
  3. replaces any systems in the SimpleLab dataset with datasets in contributed_pws.gpkg, creating an updated ref_pws.gpkg in the dedicated Hydroshare resource. The SimpleLab workflow includes data from official state sources or estimated based on their methods. Where a system is contributed to this repository that is not from an official state source, it is assumed to be of higher quality than the estimated boundaries, which are either Census Place boundaries or circular service reas centered on a facility location.

How to contribute

This is a moderated repository. In general, if an individual, community, utility, or community group wishes to submit a boundary, particularly one that overrides one available from an official state source, we will ask for specific justifications and data sources. We may also refer you to contribute your boundary to an official state reporting mechanism if the boundary for the water system is within a state that has such a mechanism. If there is no official state mechanism, justifications and data sources. can be provided in the GitHub pull request or over email.

It is preferred to submit a boundary through GitHub via Pull Request. If you wish to submit a boundary and are unfamiliar with GitHub, please email konda@lincolninst.edu, and we will be happy to assist you.

What to contribute

It is preferred to submit .geojson file named {pwsid}.geojson to the appropriate state contribution/{state-code} directory. The file should be formatted as in this example, with 8 fields (please make sure all fields are in lower case, or data will not be ingested):

  • pwsid as {2-letter-state-code}{pwsid number} e.g. MA3035000
  • name, the name of the water system e.g. Boston Water and Sewer Service Commission
  • service_area_type, whether the system represents the current actual "current service area", or the nominal "jurisdictional area" for which water must be supplied upon application
  • data_source, the type of data that the boundary was generated from, which can be one of:
    • Census Place
    • Image from Utility
    • Description from Utility
    • Water Lines
    • Layer from Utility
    • County boundary with other systems removed
  • source_url, a URL detailing the dataset or organization where the information came from, if available
  • contact_email, the email address for the person providing the file
  • source_date, the date that the contributed data was last updated (YYYY-MM-DD)
  • contribution_date, the date that the data was contributed (YYYY-MM-DD)