Fix example output

[tsmbland]

Description

The example-output.ipynb notebook is used to run an example simulation in the documentation. This serves two purposes: 1) To show an example of the command-line output produced by MUSE. See here 2) To create a Results folder which is visualised on this page

As you can see, the page showing the example output is broken, as it's trying to point to a settings file that doesn't exist. I've fixed this by running the default simulation instead. The Results folder outputted by this simulation is almost identical to before, just a few files are different (perhaps the model has changed slightly since the results were last generated?). In any case, these changes do not affect the figures plotted in the "Running MUSE example" page.

The main change in the files that have been modified is that rows have been split into multiple 'assets'. I'm not exactly sure when/why this was changed, but summing supply for the different assets looks equivalent to how it was before (on a quick glance). Columns for 'technology' and 'installed' have also been added.

The new documentation can be downloaded from here. The relevant page is example-output.html

Fixes #258

Type of change

Please add a line in the relevant section of CHANGELOG.md to document the change (include PR #) - note reverse order of PR #s.

• [ ] New feature (non-breaking change which adds functionality)
• [ ] Optimization (non-breaking, back-end change that speeds up the code)
• [x] Bug fix (non-breaking change which fixes an issue)
• [ ] Breaking change (whatever its nature)

Key checklist

• [ ] All tests pass: $ python -m pytest
• [ ] The documentation builds and looks OK: $ python -m sphinx -b html docs docs/build

Further checks

• [ ] Code is commented, particularly in hard-to-understand areas
• [ ] Tests added that prove fix is effective or that feature works

[dalonsoa]

LGTM!

Side note: @dalonsoa Is there a reason why results files for the examples are committed to the repo? It seems like the sort of thing that would normally be .gitignore'd. Though I can see that we might want sample outputs for users to plot etc...

They are used to create the plots in the examples used in the documentations, I think.

[tsmbland]

LGTM! Side note: @dalonsoa Is there a reason why results files for the examples are committed to the repo? It seems like the sort of thing that would normally be .gitignore'd. Though I can see that we might want sample outputs for users to plot etc...

They are used to create the plots in the examples used in the documentations, I think.

Yeah, but I guess the results are generated every time the documentation is build, so they wouldn't actually need to be committed to the repo

[dalonsoa]

Mmmmm... maybe you're right, yes. To be honest, I'm not entirely sure if the notebooks are run when the documentation is built in ReadTheDocs.

[alexdewar]

I'll check and fix up if needed.