Add report generation package by sriharisundar · Pull Request #92 · NatLabRockies/PRAS

sriharisundar · 2025-10-01T13:47:13Z

No description provided.

codecov-commenter · 2025-10-01T13:49:00Z

Codecov Report

❌ Patch coverage is 92.41877% with 21 lines in your changes missing coverage. Please review.
✅ Project coverage is 84.97%. Comparing base (f49c56e) to head (cdf5e74).
⚠️ Report is 1 commits behind head on main.

Files with missing lines	Patch %	Lines
PRASReport.jl/src/writedb.jl	92.30%	14 Missing ⚠️
PRASCore.jl/src/Results/Shortfall.jl	0.00%	4 Missing ⚠️
PRASReport.jl/src/events.jl	96.72%	2 Missing ⚠️
PRASCore.jl/src/Results/Results.jl	0.00%	1 Missing ⚠️

Additional details and impacted files

@@            Coverage Diff             @@
##             main      #92      +/-   ##
==========================================
+ Coverage   84.14%   84.97%   +0.82%     
==========================================
  Files          45       49       +4     
  Lines        2491     2768     +277     
==========================================
+ Hits         2096     2352     +256     
- Misses        395      416      +21

☔ View full report in Codecov by Harness.
📢 Have feedback on the report? Share it here.

🚀 New features to boost your workflow:

❄️ Test Analytics: Detect flaky tests, report on failures, and find test suite problems.

Copilot

Pull Request Overview

This PR adds a new PRASReport.jl package to the PRAS ecosystem that generates interactive HTML reports for power system resource adequacy analysis results. The package extracts "events" (periods of energy shortfall above a threshold) from PRAS simulation results and creates visualizations using embedded databases and web technologies.

Key changes:

Implements event extraction and analysis from PRAS ShortfallResult objects
Creates interactive HTML reports with charts and tabular views using DuckDB WASM
Provides multiple input methods (results, system models, or file paths)

Reviewed Changes

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

Show a summary per file

File	Description
PRASReport.jl/src/	Core package implementation with event extraction, database operations, and HTML report generation
PRASReport.jl/test/	Test suite covering event extraction and report generation workflows
PRASReport.jl/examples/	Example usage script
PRASCore.jl/src/Results/	Extension to support new NEUE calculations needed by reporting
.github/workflows/	CI configuration for the new package

_{Tip: Customize your code reviews with copilot-instructions.md. Create the file or learn how to get started.}

Copilot · 2025-10-01T14:15:30Z

+                     regions::Vector{String}
+                    ) where {N,L,T,E}
+
+        length(lole) != length(eue) != length(neue) != length(regions) && 


This chained inequality comparison doesn't work as intended in Julia. It should be length(lole) != length(eue) || length(eue) != length(neue) || length(neue) != length(regions) to check that all vectors have equal length.

Suggested change

length(lole) != length(eue) != length(neue) != length(regions) &&

(length(lole) != length(eue) || length(eue) != length(neue) || length(neue) != length(regions)) &&

Second this

Copilot · 2025-10-01T14:15:30Z

+    _write_db!(::ShortfallResult{N,L,T,E}, ::FlowResult{N,L,T,P}, 
+    threshold::Int, conn::DuckDB.Connection)
+
+Write system and simulation parameters to the parameters table.
+"""
+function _write_db!(sf::ShortfallResult{N,L,T,E}, 
+                    ::FlowResult{N,L,T,P},
+                    threshold::Int64, 


The second parameter is unused (anonymous with ::FlowResult). If the FlowResult is not needed for this function, consider removing it from the signature or document why it's required for the interface.

Suggested change

_write_db!(::ShortfallResult{N,L,T,E}, ::FlowResult{N,L,T,P},

threshold::Int, conn::DuckDB.Connection)

Write system and simulation parameters to the parameters table.

"""

function _write_db!(sf::ShortfallResult{N,L,T,E},

::FlowResult{N,L,T,P},

threshold::Int64,

_write_db!(sf::ShortfallResult{N,L,T,E},

threshold::Int, conn::DuckDB.Connection)

Write system and simulation parameters to the parameters table.

"""

function _write_db!(sf::ShortfallResult{N,L,T,E},

threshold::Int64,

Not sure why this was marked resolved.

…, start tests

…tem level result

…bse; Remove views in the db schema, can bring back in later if needed; Make many functions internal and don't export

scdhulipala · 2026-09-03T20:02:43Z

+function NEUE(x::ShortfallResult{N,L,T,E}, r::AbstractString, t::ZonedDateTime) where {N,L,T,E}
+    i_r = findfirstunique(x.regions.names, r)
+    i_t = findfirstunique(x.timestamps, t)
+    return NEUE(div(MeanEstimate(x[r, t]..., x.nsamples),x.regions.load[i_r,i_t]/1e6))


Check if the load = 0 update ever made it through as tests might fail.

scdhulipala · 2026-09-03T20:15:09Z

Not sure if this should be here. We don't have this in any other repos.

scdhulipala · 2026-09-04T17:21:16Z

+CREATE TABLE events (
+    id INTEGER PRIMARY KEY DEFAULT nextval('eventid_sequence'),
+    name TEXT NOT NULL,
+    start_timestamp TIMESTAMP WITHOUT TIME ZONE NOT NULL,


Is this different from the start_timestamp in the systemsinfo table?

scdhulipala · 2026-09-04T18:24:07Z

@@ -0,0 +1,95 @@
+-- System and Simulation parameters 


General comment here: DuckDB is incredbly fast at doing some of the calculatins we do for EUE, nEUE, etc. I know this might mean a full overhaul of the schema but something to think about.

scdhulipala · 2026-09-04T18:28:02Z

+                     regions::Vector{String}
+                    ) where {N,L,T,E}
+
+        length(lole) != length(eue) != length(neue) != length(regions) && 


Second this

scdhulipala · 2026-09-04T18:46:17Z

@@ -0,0 +1,141 @@
+"""


General comment: Is the API we want to go with? I don't have any comments on the code here, I'm not sure `create_pras_report(args, kwargs,) is what we like?

scdhulipala · 2026-09-04T18:55:19Z

+    _write_db!(::ShortfallResult{N,L,T,E}, ::FlowResult{N,L,T,P}, 
+    threshold::Int, conn::DuckDB.Connection)
+
+Write system and simulation parameters to the parameters table.
+"""
+function _write_db!(sf::ShortfallResult{N,L,T,E}, 
+                    ::FlowResult{N,L,T,P},
+                    threshold::Int64, 


Not sure why this was marked resolved.

scdhulipala · 2026-09-04T19:00:30Z

+                            threshold::Int=0,
+                            title::String="Resource Adequacy Report")
+
+    base64_db = _get_base64_db((system_path,);threshold=threshold,


Why can't we load the system and call the function above?

scdhulipala · 2026-09-04T20:04:47Z

+                threshold=0, 
+                samples=nothing, seed=nothing) where {N,L,T,P,E}
+
+    if isnothing(conn)


This gets called from _get_base64_db. I guess I don't understand why conn would ever be Nothing?

scdhulipala · 2026-09-04T20:07:37Z

+    events = get_events(sf,threshold)
+
+    # Write events to database (events, system metrics, regional metrics)
+    foreach(event -> _write_db!(event,conn), events)


Could you use the appender API here?

scdhulipala · 2026-09-04T20:22:54Z

Couple of other comments:

I feel like the embedding of the file directly into the HTML needs to be checked for scalability.
Based on the tests, we might want to take a two file approach (.duckdb + .html)?
Probably also include a caveat about how the report cannot be viewed offline maybe?

hsunnrel requested a review from Copilot October 1, 2025 14:14

Copilot AI reviewed Oct 1, 2025

View reviewed changes

sriharisundar added 14 commits August 24, 2026 18:32

Initial commit, get event info for system and regions

88c20c3

Make changes for copperplate system, more checks when creating events…

ae92a54

…, start tests

Add sf and flow structs

c63daeb

Create SQL db schema, write functions and getting db etc

28edc36

Working events and sf+flow timeseries DB export

cbe11c4

Have a working html template which shows the events table for the sys…

71494cc

…tem level result

Change how timestamps are saved, add few more elements to webpage

6449d12

Add charts, option to export the underlying DB, report title

3b5ba7f

Events table as a scrollable element

835c224

Better exposed functions - provide system or path to get html or data…

ea5a1d3

…bse; Remove views in the db schema, can bring back in later if needed; Make many functions internal and don't export

Add tests!

6f7fca3

Add test runner and update gitignore

b94eab2

Add simple usage instructions in PRASReport.jl/README.md

befdb54

Rename create_html_report to create_pras_report

23c1488

sriharisundar force-pushed the ssh/PRAS_report branch from 26d3d92 to 23c1488 Compare August 25, 2026 00:33

sriharisundar added 2 commits August 24, 2026 18:34

Remove todo.md

60048b0

Update Hari email and License to NLR

06d6686

sriharisundar marked this pull request as ready for review August 25, 2026 00:38

sriharisundar requested a review from scdhulipala August 25, 2026 00:38

Update report Project.toml to ensure tests work

cdf5e74

scdhulipala requested changes Sep 4, 2026

View reviewed changes

	length(lole) != length(eue) != length(neue) != length(regions) &&
	(length(lole) != length(eue) \|\| length(eue) != length(neue) \|\| length(neue) != length(regions)) &&

Uh oh!

Conversation

sriharisundar commented Oct 1, 2025

Uh oh!

codecov-commenter commented Oct 1, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Codecov Report

Uh oh!

Copilot AI left a comment

Choose a reason for hiding this comment

Pull Request Overview

Reviewed Changes

Uh oh!

Copilot AI Oct 1, 2025

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Copilot AI Oct 1, 2025

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

scdhulipala commented Sep 4, 2026

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

4 participants

codecov-commenter commented Oct 1, 2025 •

edited

Loading