[REQ] Add HDF5 helper methods to extract simulation run information #43
Description
What is the requirement? Please describe.
We store a lot information in the HDF5 files that we produce at the end of a simulation, but these files contain a lot of data and it's a bit difficult for someone new to figure out how to access all the information.
We also have known metrics specific to TOpSim results that it makes sense to calculate for the user, rather than have them try and figure out how to get those metrics themselves.
Describe the solution you'd like
A clear and concise description of the outcome of the requirement.
We should have an API that provides easier access to the dataframes that we store in the HDF5.
A good initial approach will be to extract what we currently have in the experiments repository, and use that to inform what data transformations we already do.
Having a 'SimulationEvents' object and a 'SimulationActors' object as wrappers for the two summary and sim dataframes we store may prove useful as well. From these, we can build potential visualisations as well.
Describe alternatives you've considered
Currently the alternative is none of this, which is a worse alternative.
Additional context
This should lead to visualisation utilities as well, also based on the data transformation we are experimenting with in the experiments repository.