nismod/smif

Improve results API

fcooper8472 opened this issue · 4 comments

A few convenience methods to add to the results api:

  • Given a sector model name, return a list of output names
  • Given a model run name, return a list of sector models
  • Given a model run name return a list of names of scenarios
  • Given a scenario name, return a list of names of scenario outputs

Also:

  • Add the scenario information to results.available_results()

Question for @willu47:

Scenarios are in the model run like so:

scenarios:
  population: population_med
  climate: central
  reservoir_level: historical
  water_sector_energy_demand: central

You want a list of scenario names given a model run... do you want:

['population', 'climate', 'reservoir_level', 'water_sector_energy_demand']

or

['population_med', 'central', 'historical', 'central']

or something else?

Perhaps just return the dictionary?

First draft is ready - @willu47 I'll open a PR for your comments on the interface

Closed by #374