OCHRE icon indicating copy to clipboard operation
OCHRE copied to clipboard

Docs Improvements

Open jmaguire1 opened this issue 2 years ago • 2 comments

  • [x] Fix any broken image links in .rst
  • [x] Add changelog
  • [ ] Step by step BEopt guide (w/ pics)
  • [ ] ResStock guide? Or better guidance on other resources?
  • [ ] If I'm feeling crazy ambitious update tables w/ footnotes

jmaguire1 avatar Aug 03 '23 18:08 jmaguire1

I just realized we didn't put Envelope input parameters in the docs. We should add that soon

mnblonsky avatar Aug 24 '23 17:08 mnblonsky

A few other docs updates from a discussion today:

  • [ ] More advanced dwelling set up that includes Equipment-specific arguments (in the docs, not just in run_dwelling.py)
  • [ ] More advanced dwelling/equipment control examples (in the docs, not just in python/notebooks)
  • [ ] Review Python snippets and make sure they run
  • [x] Split time series output tables by end use, and add verbosity levels (might be done in dev branch)
  • [ ] Update publications

mnblonsky avatar Apr 12 '24 20:04 mnblonsky