Skip to content

docs: reframe project langauge for small C&I sites#69

Merged
jdhoffa merged 1 commit into
mainfrom
docs-update_language
Feb 20, 2026
Merged

docs: reframe project langauge for small C&I sites#69
jdhoffa merged 1 commit into
mainfrom
docs-update_language

Conversation

@jdhoffa
Copy link
Copy Markdown
Owner

@jdhoffa jdhoffa commented Feb 20, 2026

No description provided.

Copilot AI review requested due to automatic review settings February 20, 2026 10:41
@github-actions
Copy link
Copy Markdown
Contributor

github-actions Bot commented Feb 20, 2026

Docs preview was removed because this PR is closed.

@jdhoffa jdhoffa merged commit 6ddf1f8 into main Feb 20, 2026
7 checks passed
@jdhoffa jdhoffa deleted the docs-update_language branch February 20, 2026 10:42
github-actions Bot added a commit that referenced this pull request Feb 20, 2026
Copy link
Copy Markdown
Contributor

Copilot AI left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Pull request overview

Reframes project documentation and inline comments from a residential/neighborhood framing toward “small C&I site-scale” VPP simulations.

Changes:

  • Updates README language and device list to emphasize on-site assets and generic flexible electric loads.
  • Broadens inline documentation in the controller and EV charger model to be less residential/EV-specific.

Reviewed changes

Copilot reviewed 3 out of 3 changed files in this pull request and generated 2 comments.

File Description
src/sim/controller.rs Expands doc comment examples for flexible-load capping to include non-EV load types.
src/devices/ev_charger.rs Rewords module/type documentation to position the model as a generic session-based flexible electric load.
README.md Updates project description and feature bullets to target small C&I site-scale use cases and broad flexible-load examples.
Comments suppressed due to low confidence (1)

src/devices/ev_charger.rs:16

  • The doc comment now describes this as a generic flexible electric load model, but the public type/file/module name is still EvCharger and the API fields are EV-specific (e.g., max_charge_kw, session arrival/deadline). This can be confusing for users reading generated docs; consider either keeping the wording EV-focused, or explicitly stating that EvCharger is reused as a generic “session-based flexible load” model and pointing to any intended mapping to non-EV loads.
/// A flexible electric load model using EV-style charging sessions.
///
/// Each simulated day, this model samples one charging session with:
/// - random arrival time
/// - random dwell duration (which sets deadline)
/// - random required energy in kWh

💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.

Comment thread README.md
[![License: MIT](https://img.shields.io/badge/License-MIT-yellow.svg)](LICENSE)

The **Virtual Power Plant Simulator** is an open source project aiming to simulate a neighborhood-scale Virtual Power Plant (VPP) in real time.
The **Virtual Power Plant Simulator** is an open source project for simulating small C&I site-scale Virtual Power Plant (VPP) behavior in real time.
Copy link

Copilot AI Feb 20, 2026

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

The new "small C&I site-scale" framing introduces an acronym (C&I) that isn’t defined anywhere else in the repo, and the rest of the README (e.g., the example scenario field houses and the sample output referencing EvCharger) still reads like a residential/house-based demo. Consider expanding the acronym on first use (e.g., “commercial & industrial (C&I)”) and either updating the later examples/terminology to match the site-scale framing or adding a short note that the demo scenario is still expressed in “houses” as a proxy unit.

Suggested change
The **Virtual Power Plant Simulator** is an open source project for simulating small C&I site-scale Virtual Power Plant (VPP) behavior in real time.
The **Virtual Power Plant Simulator** is an open source project for simulating small commercial & industrial (C&I) site-scale Virtual Power Plant (VPP) behavior in real time.

Copilot uses AI. Check for mistakes.
Comment thread README.md
Comment on lines +10 to +13
- ☀️ On-site solar PV
- 🔋 On-site battery storage systems
- ⚙️ Flexible electric loads (e.g., EV charging, pumps, refrigeration)
- 💡 Baseline and controllable site demand
Copy link

Copilot AI Feb 20, 2026

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This bullet implies the simulator includes distinct models for pumps/refrigeration, but in src/devices/ the only flexible electric load model appears to be EvCharger (EV-session based). To avoid overstating current functionality, consider rephrasing this to clarify that non-EV flexible loads are represented using EV-style sessions (or remove the pump/refrigeration examples until models exist).

Copilot uses AI. Check for mistakes.
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

Successfully merging this pull request may close these issues.

2 participants