Cambium api additions by StephenPaul27 · Pull Request #669 · NatLabRockies/SAM

StephenPaul27 · 2021-07-27T21:40:05Z

I just merged develop, fixed conflicts, and ran the test script, the results came out clean and everything seems to be working fine so let me know if there's anything you spot that needs fixing/updating.

LK/WEX/SSC branch names are all also cambium_api_additions, I'll create separate pull requests for those I guess

working version of API Form, msgbox output

Added tooltips and target for api copy

Includes changes to default files for merchant plant cases as well as the UI pages related to the cambium API itself (after passing test_script_ow.lk)

Added incrementing year option to the cambium year selection input.

all defaults have been merged without test script conflict

everything seems to check out

cpaulgilman · 2021-07-28T18:26:40Z

Please remove colons from UI variable labels to be consistent with rest of UI:

The on_load() function for Cambium API Data and Cambium Tab UI forms appear to be similar. Are both required, or can that code be consolidated in one place to make it easier to maintain?
The urls for the Cambium API calls are hard-coded in the UI callback LK script instead of being stored in the runtime/webapis.conf file and read with the webapi() function. See Solar Resource and Marine Wave Resource Time Series forms for examples of the webapi() function.
Is the project_uuid variable to store an NREL Developer API key? If so, I think it should use the SAM API key with code similar to this code snippet from the Solar Resource UI callback. For official release versions of SAM, the curl() function should convert to the SAM's NREL Developer API key (this only works for versions of SAM built from SAM-private):

base_url = dataset[n].url;
base_url += '?api_key=<SAMAPIKEY>';
base_url += '&full_name=sam_user';
base_url += '&email=<USEREMAIL>';

Is the Financial Merchant Plant form still needed? If not please remove it by deleting the .txt file in the ui folder.

StephenPaul27 · 2021-07-28T20:00:56Z

1, 3, & 5: Thanks for pointing these out, I'll fix them today.
2: The on_load was the only function I found necessary to duplicate when creating the "dummy" UI forms for the tabs because of the difference in the form name triggering the load. I can try to either consolidate or reduce what is there currently.
4: The project_uuid is specific to Cambium and just differentiates which data set we're calling to.

So the project_uuid in the UI specifies that we're getting data from that first set of scenarios "Cambium Scenarios (Hourly and annual)"
Let me know if this should be relocated somewhere.

cpaulgilman · 2021-07-28T20:05:42Z

Thanks, Stephen. The project_uuid is fine where it is -- I just wanted to make sure we are not storing API keys in the UI callback code.

Removed Financial Merchant Plant and unused Financial Capacity Tab UI forms Removed colons from labels Consolidated on_load function (it was perfectly transferrable, though it seems to negligibly slow down the tab load times) API url info moved to webapi.conf, project_uuid remains in callback code

sjanzou

Please remove the .txt file per comments and move the uuid to private.h in SAM-private as used for the so that the SAM Cambium key is "hidden" from webapis.conf. What will the final defaults used be - hourly, single value and then populated by Cambium? Great Work!

updated verbage for Cambium description to reflect how Cambium defines its data

Add title property to tooltip widget.

New sample script to download cambium data to PPA models.

sjanzou · 2021-10-21T07:00:24Z

If the uuids are used for the different years, then, yes - definitely okay to have in the webapis.conf. Thanks for the clarification.

…

On Wed, 20 Oct 2021 at 16:35, Paul Gilman ***@***.***> wrote: Please remove the .txt file per comments and move the uuid to private.h in SAM-private as used for the so that the SAM Cambium key is "hidden" from webapis.conf. What will the final defaults used be - hourly, single value and then populated by Cambium? Great Work! @sjanzou <https://github.com/sjanzou> This "uuid" does not appear to be a secret API key. It is a project ID and appears in the URL when you browse to the Cambium site on the web. Each year in the database is a separate "project" with its own UUID. For example, the 2020 database is at https://cambium.nrel.gov/?project=579698fe-5a38-4d7c-8611-d0c5969b2e54&mode=view&layout=Default%20Layout,and the 2019 database is at https://cambium.nrel.gov/?project=80f470e3-419f-4bbd-92de-0bd9877a9ab7&mode=view&layout=Default . Given that this is a public ID, I think it is OK to have it in the callback and webapis.conf. Do you agree? — You are receiving this because you were mentioned. Reply to this email directly, view it on GitHub <#669 (comment)>, or unsubscribe <https://github.com/notifications/unsubscribe-auth/ABRSQBYZKKOTDSEA332OGIDUH47Z3ANCNFSM5BDCWB7A> .

StephenPaul27 added 9 commits June 15, 2021 16:54

Limited working API Form

ee83db7

working version of API Form, msgbox output

Added tooltips and target for api copy

f898c8d

Added tooltips and target for api copy

Cambium API addition

091b69f

Includes changes to default files for merchant plant cases as well as the UI pages related to the cambium API itself (after passing test_script_ow.lk)

added incrementing year option, fixed some titles

dd70817

Added incrementing year option to the cambium year selection input.

Merge branch 'develop' into cambium_api_additions

32b99b2

fixed changes after running test script

ac78b75

all defaults have been merged without test script conflict

Merge branch 'develop' into cambium_api_additions

4749c63

Merge branch 'develop' into cambium_api_additions

da203c5

merged develop and ran test script

40caedd

everything seems to check out

StephenPaul27 requested a review from sjanzou July 27, 2021 21:40

StephenPaul27 added 2 commits July 28, 2021 17:21

Cleaned up some code in cambium callback

7344456

sjanzou requested changes Aug 3, 2021

View reviewed changes

Comment thread deploy/runtime/webapis.conf

Comment thread deploy/runtime/ui/.txt Outdated

StephenPaul27 added 2 commits August 3, 2021 08:46

Delete .txt

e3d644b

updated verbage for Cambium description

37f2ab0

updated verbage for Cambium description to reflect how Cambium defines its data

janinefreeman requested a review from cpaulgilman September 14, 2021 20:54

janinefreeman assigned cpaulgilman Oct 8, 2021

cpaulgilman added 3 commits October 18, 2021 16:04

Cambium UI cleanup

867ceb3

Add title property to tooltip widget.

Clean up merchant plant callbacks and startup script

59f9a5f

New sample script to download cambium data to PPA models.

Merge branch 'develop' into cambium_api_additions

0ad053e

cpaulgilman added 4 commits October 22, 2021 16:33

Fix HTML message when no internet connection

9de7baf

fix defaults for test script

65871c8

Update test_results_win64.csv

4281b55

Update test_results_win64.csv

5f68137

cpaulgilman approved these changes Oct 26, 2021

View reviewed changes

cpaulgilman merged commit 0e5e81f into develop Oct 26, 2021

brtietz added this to the SAM Fall 2021 Release milestone Dec 3, 2021

cpaulgilman deleted the cambium_api_additions branch December 7, 2021 23:02

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Cambium api additions#669

Cambium api additions#669
cpaulgilman merged 20 commits into
developfrom
cambium_api_additions

StephenPaul27 commented Jul 27, 2021

Uh oh!

cpaulgilman commented Jul 28, 2021

Uh oh!

StephenPaul27 commented Jul 28, 2021

Uh oh!

cpaulgilman commented Jul 28, 2021

Uh oh!

sjanzou left a comment

Uh oh!

Uh oh!

Uh oh!

sjanzou commented Oct 21, 2021 via email

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

4 participants

Conversation

StephenPaul27 commented Jul 27, 2021

Uh oh!

cpaulgilman commented Jul 28, 2021

Uh oh!

StephenPaul27 commented Jul 28, 2021

Uh oh!

cpaulgilman commented Jul 28, 2021

Uh oh!

sjanzou left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

sjanzou commented Oct 21, 2021 via email

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

4 participants