Calibratable Implementation

[hellkite500]

This work in progress attempts to define a simple calibratable interface that is useable by the search algorithm (DDS). A hypy.Catchment subclass implements this interface and makes the connection of the abstract data to an operable form.

Related to NOAA-OWP/hypy#6
Closes #1

Additions

• calibrateable.py
• `calibration_catchment.py
• search.py

Changes

• removed dds loop from calibraiton.py into its own function in search.py

Testing

1. test module for search.py in place, others need created to finish this PR.

Todos

• TEST COVERAGE!

Checklist

• PR has an informative and human-readable title
• Changes are limited to a single goal (no scope creep)
• Code can be automatically merged (no conflicts)
• Code follows project standards (link if applicable)
• Passes all existing automated tests
• Any change in functionality is tested
• New functions are documented (with a description, list of inputs, and expected output)
• Placeholder code is flagged / future todos are captured in comments
• Project documentation has been updated (including the "Unreleased" section of the CHANGELOG)
• Reviewers requested with the Reviewers tool ➡️

Testing checklist

Target Environment support

• Linux
• MacOS

[hellkite500]

@NOAA-OWP/next-gen This work is still a little rough around the edges, but I think it is to a point where it should be easier to work with at this point. A few functions still need implementations, but they should be relatively straight forward.

[hellkite500]

I have also epically failed in providing any (let along good) inline documentation. I will try to get some of that sorted today.

[hellkite500]

This PR/Branch has picked up some scope creep. The latest commits rework the calling code to make it not error and to run through to the dds loop at the end of main. Due to the amount of dependence on the catchment/calibratable interface, I just added this on top of this branch. I'm going to pause and get all this merged before moving forward with too many more changes.