search

SEED-platform / seed

Standard Energy Efficiency Data (SEED) Platform™ is a web-based application that helps organizations easily manage data on the energy performance of large groups of buildings.
Other
107 stars 55 forks source link

BETTER - individual analyses for portfolios #3968

Closed perryr16 closed 1 month ago

perryr16 commented 1 year ago

When viewing a Portfolio Analysis Standalone HTML file there are links to download the individual building analyses. However, the download button does not display within the SEED <iframe>. See the below correspondance from Han Li at LBNL

Hey @Ross Perry, @Daniel McQuillen and I have discussed the issue. The problem with the download links in the standalone portfolio analytics HTML is that they direct to BETTER web app (non API), which requires login. But our understanding is that individual SEED users don't have access to the master BETTER account. So our suggestion is that we disable the download links from the standalone portfolio HTML. You can add the download links somewhere outside of the iframe window via the standalone building analytics API

We will need to refactor the BETTER portfolio analysis flow to request individual PortfolioBuildingAnalyses for each building in the portfolio and attach them to the displayed analysis. I'm not sure where we should display the portfolio analysis.

Reference Documents BETTER V2 Documentation Notebook created by better with example calls

perryr16 commented 1 year ago

Email me for a jupyter notebook used for testing the SEED BETTER flow

RDmitchell commented 1 year ago

I talked to Daniel about how all this works and now that I understand that the iFrame world is actually looking at the BETTER website, I'm not sure we should be doing any of the reports using iFrame.

What happens if someone on the BETTER side deletes the run / report?

Seems like we should be storing the actual HTML file that was obtained from the BETTER run, and then displaying it as HTML in SEED, not getting it via the iFrame world. ???

RDmitchell commented 1 year ago

It is similar to how we are getting Audit Template XML files, ie, we're not looking at the Audit Template website, we are downloading the XML file and storing it in SEED so that we have it archived forever.

I think we need to think about the BETTER reports in the same way, ie, download the HTML file, store it in SEED, view it in SEED from that HTML file, and then the user will always have it archived, even if it gets deleted from the BETTER website.

github-actions[bot] commented 1 year ago

This issue has been automatically marked as stale because it has not had recent activity within 60 days. It will be closed if no further activity occurs. Thank you for your contributions.

github-actions[bot] commented 1 year ago

This issue has been automatically marked as stale because it has not had recent activity within 60 days. It will be closed if no further activity occurs. Thank you for your contributions.

github-actions[bot] commented 11 months ago

This issue has been automatically marked as stale because it has not had recent activity within 60 days. It will be closed if no further activity occurs. Thank you for your contributions.

github-actions[bot] commented 9 months ago

This issue has been automatically marked as stale because it has not had recent activity within 60 days. It will be closed if no further activity occurs. Thank you for your contributions.

github-actions[bot] commented 7 months ago

This issue has been automatically marked as stale because it has not had recent activity within 60 days. It will be closed if no further activity occurs. Thank you for your contributions.

RDmitchell commented 7 months ago

@kflemin -- it would be nice if we could squeeze this in to the Q2 bug fixes, because right now the BETTER reporting world is a bit broken because of this. I suspect we will have to work with the BETTER team to figure out what the issue is.

RDmitchell commented 7 months ago

Instance: staging SHA: 1dc901360 Org; ID = 410

This is what is currently happening.

In the Analysis screen, when you click on the link for an individual building image

The program displays this error message image

We need to work with the BETTER team to figure out a way for this to work without having the users log into their accounts. The BETTER users have already entered an API key, specific to their account, in SEED. Hopefully we can leverage that instead of an actual login.

I will get in touch with the BETTER team and see if we can schedule a meeting at some point in the next few months to work on this, so that it is working by the ACEEE Summer Session, where the BETTER team will presenting a paper on the SEED/BETTER connection.

perryr16 commented 7 months ago

thanks for documenting @RDmitchell

RDmitchell commented 7 months ago

@perryr16 / @kflemin -- I sent the BETTER team an email today about this issue, and asked them to find some time to work with us on this in the next few months. The ACEEE conference is in the beginning of August, so we have some time to address this.

RDmitchell commented 1 month ago

@perryr16 / @kflemin -- testing this today (LBNL staging for the 3.0.0 release), I can either generate individual reports for each building or portfolio reports, based on whether I select the Portfolio Report option when setting up the runs.

This doesn't seem ideal, but at least it is possible to get to one or the other, but you need to do 2 separate runs.

I think I am going to close this issue, and write up the current behavior in a new issue, and then at some point (probably in FY 25) with the BETTER team about how to improve this, ie, generate both the individuals reports, as well as only ONE portfolio report, for a given analysis.