Contribution to OLI documentation efforts #1259
Conversation
exception test for get_credentials() Co-authored-by: Adam Atia <[email protected]>
Codecov ReportAttention:
Additional details and impacted files@@ Coverage Diff @@
## main #1259 +/- ##
==========================================
- Coverage 94.24% 94.19% -0.06%
==========================================
Files 360 360
Lines 36280 36336 +56
==========================================
+ Hits 34191 34225 +34
- Misses 2089 2111 +22 ☔ View full report in Codecov by Sentry. |
| exclude_items = ["temperature", "pressure", "volume"] | ||
| if watertap_name.lower() in exclude_items: | ||
| return watertap_name |
There was a problem hiding this comment.
What made you add this? Just wondering what popped up that triggered a need for this since I figured one would only provide a solute name as input (imagining that you tried automatically looping through state vars or something like that but not sure).
There was a problem hiding this comment.
I added this because of how build_survey works: https://github.com/watertap-org/watertap/blob/7c0d684ee36ecee360513601942d54b289fa2bd3/watertap/tools/oli_api/flash.py#L100C5-L125C22
It does loop through each survey parameter and try to get an oli_name from it
| "source": [ | ||
| "try:\n", | ||
| " credential_manager = CredentialManager(\n", | ||
| " #encryption_key=\"\",\n", |
There was a problem hiding this comment.
Is it necessary to include encryption_key=""? Can I just not include the argument, resulting in either the default being set to empty string or, if a local file with keys is found, prompt user for encryption key? My main question is do I have to include the line encryption_key="" or did you just include for clarity?
There was a problem hiding this comment.
It is not necessary to include encryption_key="" in the arguments. Each argument is listed for all login scenarios in the example, and when an argument is not required for a scenario I've commented it out.
|
Is this still needed after #1237 is merged? |
|
This can be closed. I'll revise documentation/tutorials from a clean branch once #1237 is merged. |
Fixes/Resolves:
Improves documentation #1206
Summary/Motivation:
Improved demonstrations for core functionality of OLI-related features
Changes proposed in this PR:
Legal Acknowledgement
By contributing to this software project, I agree to the following terms and conditions for my contribution: