Skip to content

Latest commit

 

History

History
59 lines (46 loc) · 4.48 KB

CONTRIBUTING.md

File metadata and controls

59 lines (46 loc) · 4.48 KB
Raw

Contributing to OWRS

This repository documents how to contribute data to the Open Water Rate Specification (OWRS), a machine-readable format for specifying and sharing water rate information.

OWRS is designed so that anyone can contribute standardized water rate data.

Getting Started (Web survey survey.californiadatacollaborative.org)

  1. Refer the OWRS README for background information

  2. Find an unclaimed utility on the spreadsheet tracking OWRS status for California water utilities and put your name in the "Assignment" column to claim it as yours.

  3. Google search the Utility name (Moulton Niguel Water District) and "water rate" to find the page containing water rate information.

  4. Use the OWRS creator web form ( survey.californiadatacollaborative.org ) and carefully answer the questions based on what you see on the Agency’s Water rate page.

  5. If you have any questions, please email [email protected].

  6. After you have completed answering all questions, mark the agency as DONE in the spreadsheet tracking OWRS status for California water utilities.

  7. Pick another utility!

  8. GOTO #2 ...

  9. Iterate ...

  10. Pioneer a brighter future for CA!

Getting Started (Git)

Follow these simple steps (The example we use here is Moulton Niguel Water District)

  1. Refer the OWRS README
  2. Fork the OWRS repo to your own Github.
  3. Clone the forked OWRS repo locally to your machine. git clone <LINK to the FORKED REPO>
  4. Find an unclaimed utility on the spreadsheet tracking OWRS status for California water utilities and put your name in the "Assignment" column to claim it as yours.
  5. Google search the Utility name (Moulton Niguel Water District) and "water rate" to find the page containing water rate information.
  1. On your computer
    • cd Open-Water-Rate-Specification/full_utility_rates/California/
    • git checkout -b "Moulton Niguel Water District - 147"
  2. Create a new folder for that utility mkdir "Moulton Niguel Water District - 147"
  • Use the naming convention "[Agency Name] - [utility_id]" e.g. mkdir "Moulton Niguel Water District - 147"
  • [Agency Name] and [utility_id] can be found in the tracking spreadsheet.
  1. Write an OWRS file for that utility in that folder
  • Always helpful to compare with an OWRS file that already exists here
  • You will first use the generic OWRS template aka template.owrs in the templates folder
  • Based on the type of rate however - you can use the other templates (depends_on_template.owrs OR tiered_template.owrs)
  • Use naming convention "[acronym]-YYYY-MM-DD.owrs"
  • where YYY-MM-DD is the date when that utility's water rate is effective. (found on the Utility website)
  1. Ask questions on the OWRS slack as need be
  • Make sure you capture Usage units correctly (if you encounter GALLONS - then conver to ccf/hcf 1 ccf/hcf = 748.052 gallons
  1. When your OWRS file is good to go, push your changes to the remote GitHub repo and submit a pull request!
  2. A member of the CaDC data team will review the OWRS file and let you know if there are any questions
  3. Pick another utility!
  4. GOTO #4
  5. Pioneer a brighter future for CA!

Open water rate spectacular

If you're attending this event in person, please feel free to ask Chris, Vyki, Patrick, Vincent or David (in CA) or Varun / Vipassana (in NYC) if you have any questions. Regardless you can always ask questions in the open_water_rates ARGO slack channel.