Create demo_config.yml

[barneydobson]

Description

PR to implement configuration file, used to specify what to call from swmmanywhere

Fixes #9 #10 #19

In part #28 - though switching extension is not yet included - this is listed under #28

Notes:

• swmmanywhere function (is this a suitable name? conscious that it could confuse people's imports) reads a config file and calls the various functions, including downloads (if necessary), graphfcns, run, and metrics.
• Added a demo_config.yml, currently used in testing
• A bit of various debugging/improvmenets from running everything all together (there's a few find+replace here which has led to many new lines).
• New functions (iterate_graphfcns and iterate_metrics) iterate over both registers, currently within the respective utilities modules.
• object -> id in results/metrics
• assign_id is now called at the start and end of graphfcn_list, since SWMM cannot have edge names overlapping with node names (which in turn occurs due to split_long_edges - now highlighted in Refactor split_long_edges #39 )

This PR will not address:

• Creating the 'real' network information: see Convert inp file read/write to swmmio #84
• Automatic derivation of storevars from metric_list. It seems possible but can have its own issue: see Calculate storevars from metric_list #85
• Sensitivity analysis sampling interactions with config, I will bring over this functionality from experimenter.py in Paper (ignore this) #79 under issue Sensitivity analysis sampling #86
• Allow custom epsg: see Support EPSG switching from config #88

[dalonsoa]

It's looking ok, but I'm very concerned with the lack of validation of the configuration.

[barneydobson]

It's looking ok, but I'm very concerned with the lack of validation of the configuration.

@dalonsoa

Thanks for the suggestions - if you wanted to specifically check the now added schema.yml and expanded load_config that would be amazing

[dalonsoa]

This looks much better. You should add a dedicated test for load_config (not to test what jsonshema is doing, but what the other bits and pieces are doing, but otherwise it looks good now.