Getting Started¶

To use RainGaugeMatcha in a project:

import raingaugematcha

Scenarios¶

Which scenario best describes you?

Scenario	Advice	Reccomended Pipeline(s)
I have 2 sets of gauge metadata for the same underlying data	See Station matching	Automatching, Full Matching, Full Matching and Comparison
My data is in the wrong format	You will need to format your data (see advice in Data prep)...	N/A
I have timeseries data for a known set of collocated gauge pairs	See Station comparison	Comparison
I want to pair up gauges from multiple networks for comparison	See Station matching	Automatching, Full Matching, Full Matching and Comparison
I have multiple sets of gauge metadata, but no timeseries data	See Station matching	Automatching, Full Matching

Full Matching and Comparison¶

The complete pipeline, this will ingest two sets of gauge metadata, automatch them, request a manual review and then provide a basic summary of the comparison between those gauges

Inputs:

2x Gauge Metadata
Nx Timeseries Data Files

Outputs:

1x Final Matches
1x Comparison Output Table

graph LR
  A[Gauge Metadata 1] --> C{Matching Alogrithm};
  B[Gauge Metadata 2] --> C{Matching Alogrithm};
  C --> D[Accepted Matches]
  C --> E[Rank-Rejected Matches]
  C --> F[Auto-Rejected Matches]
  D --> G{Manual Matching Notebook};
  E --> G{Manual Matching Notebook};
  F --> G{Manual Matching Notebook};
  G --> H[Final Matches]
  H --> I{Comparison Algorithm};
  I --> J[Comparison Output Table]

Want to take a break?

The outputs are each stage are saved, so after any section (auto-matching, manual-matching, comparison) you can exit the process and restart by loading in the saved files

Automatching¶

The quickest and least user-involved pipeline for matching gauges

Inputs:

2x Gauge Metadata

Outputs:

1x Accepted Matches
1x Rank-Rejected Matches
1x Auto-Rejected Matches

graph LR
  A[Gauge Metadata 1] --> C{Matching Alogrithm};
  B[Gauge Metadata 2] --> C{Matching Alogrithm};
  C --> D[Accepted Matches]
  C --> E[Rank-Rejected Matches]
  C --> F[Auto-Rejected Matches]

Comparison¶

For when you know what you want to compare with what

Inputs:

1x Gauge Pair Metadata
Nx Timeseries Data Files

Outputs:

1x Comparison Output Table

graph LR
  H[Final Matches] --> I{Comparison Algorithm};
  I --> J[Comparison Output Table]

Full Matching¶

High-quality, user-reviewed matching, but no timseries comparisons required

Inputs:

2x Gauge Metadata

Outputs:

1x Final Matches

graph LR
  A[Gauge Metadata 1] --> C{Matching Alogrithm};
  B[Gauge Metadata 2] --> C{Matching Alogrithm};
  C --> D[Accepted Matches]
  C --> E[Rank-Rejected Matches]
  C --> F[Auto-Rejected Matches]
  D --> G{Manual Matching Notebook};
  E --> G{Manual Matching Notebook};
  F --> G{Manual Matching Notebook};
  G --> H[Final Matches]