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.

Sign up for GitHub

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

Jump to bottom

OCHRE Documentation #3

Closed
24 tasks done
jmaguire1 opened this issue Jul 13, 2023 · 2 comments
Closed
24 tasks done

OCHRE Documentation #3

jmaguire1 opened this issue Jul 13, 2023 · 2 comments
Assignees
@mnblonsky @jmaguire1 @sugirdhalakshmi

Comments

@jmaguire1
Copy link
Collaborator

jmaguire1 commented Jul 13, 2023 •
edited
Loading

Documentation written in word

  • OCHRE overview and scope (Jeff)
  • Installation (Michael)
  • Usage (Michael)
  • License, citations, publishing, and contact information (Jeff)
    Modeling Approach:
    • Envelope (Jeff & Michael)
    • HVAC (Jeff and Sugi)
    • Water Heating (Jeff)
    • Batteries (Michael)
    • Electric Vehicles (Michael)
    • PV (Michael)
    • Other Loads (Jeff & Michael)
    • Co-simulation (Michael)
      Input Files and Arguments:
    • HPXML (Jeff)
    • Occupancy Schedule (Jeff)
    • Weather (Jeff & Michael)
    • Generating Input Files (Jeff)
    • Dwelling Arguments (Michael)
    • Equipment Specific Arguments (Michael)
    • Outputs & Analysis (Michael)
      Controller Integration:
    • External Control Singals (Michael)
    • External Model Signals (Michael)
  • Example Use Cases (Michael)
  • Translated to .rst
  • Hosted on readthedocs
@jmaguire1
Copy link
Collaborator Author

@mnblonsky: I'm pretty happy with what's written for the envelope with the exception that I could use some help describing how we deal with radiation. Could you add a relatively high level paragraph on the approach?

@jmaguire1
Copy link
Collaborator Author

Done! We'll probably have some follow up issues to improve the documentation, but we have everything we need documented

@phaniarvind phaniarvind mentioned this issue Sep 6, 2024
Open
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees

@mnblonsky mnblonsky

@jmaguire1 jmaguire1

@sugirdhalakshmi sugirdhalakshmi

Labels
None yet
Projects
None yet
Milestone
No milestone
Development

No branches or pull requests
3 participants
@mnblonsky @jmaguire1 @sugirdhalakshmi