Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Update example scripts and docs #153

Open
14 of 18 tasks
mnblonsky opened this issue Nov 22, 2024 · 3 comments
Open
14 of 18 tasks

Update example scripts and docs #153

mnblonsky opened this issue Nov 22, 2024 · 3 comments
Assignees

Comments

@mnblonsky
Copy link
Collaborator

mnblonsky commented Nov 22, 2024

There's a few issues related to example code (in bin/ and notebook/ folders) and docs that would be good to fix to improve accessibility:

  • Update sample HPXML file to an all-electric building
  • Fix typos in examples
  • Ensure all examples run and create meaningful results
  • Create new examples for:
    • downloading ResStock 2024 files
    • new EV data (2030 NCN) and controls (script and notebook)
    • smart panel controls (see Example code for circuit sharing/pausing and smart EV charger #152)
    • extracting a single device from a Dwelling
    • co-simulation with HELICS
    • UEF test for water heater using schedule from a file
    • CTA-2045 controls for WH or HPWH
  • Create executables
    • ochre command using click
    • executable to run OCHRE without python installed (PyInstaller?)
  • Update docs
    • Introduction
    • EV model and use cases
    • Other examples (notebooks, co-sim)
@mnblonsky mnblonsky self-assigned this Nov 22, 2024
@mnblonsky mnblonsky mentioned this issue Nov 25, 2024
5 tasks
@jmaguire1
Copy link
Collaborator

Can I add one example to the list?

[ ] A water heater equipment example where all the conditions (ambient temp, ambient humidity (for HPWH), mains temp, and flow rate) are all in a data file.

We have something kind of like this for running UEF tests in the pcm branch, although a lot of the conditions other than flow are constant so not in a file. Having this all be a file would be nice not just for running tests like UEF/FHR in OCHRE, but if you want to validate a WH model against real data from the lab or field this'd be really handy.

A long time ago I had a script like this for HPWH model validation, but I think this is the closest thing we have recently (and using UEF test as the example probably makes the most sense anyways): https://github.com/NREL/OCHRE/blob/pcm-13node/bin/run_pcm_wh.py. We'd ideally just change the constant schedules to load from a csv of conditions, for this test they're constant anyways but that won't always be the case.

@mnblonsky
Copy link
Collaborator Author

I added that, and another example using CTA-2045 commands. Most new examples are in there now.

@jmaguire1
Copy link
Collaborator

Awesome, thanks Michael! This'll be really useful for a lot of future projects, and any time we want to validate a WH model (with or without controls)

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

When branches are created from issues, their pull requests are automatically linked.

2 participants