Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Materials access #130

Merged
merged 3 commits into from
Oct 25, 2024
Merged

Materials access #130

merged 3 commits into from
Oct 25, 2024

Conversation

tobin-ford
Copy link
Collaborator

Describe your changes

Suite of utility functions to facilitate accessing material parameter json files.

  • pvdeg.utilities.read_material creates a public api to replace the private pvdeg.untility._read_material function (to be deprecated soon)
  • pvdeg.utilities.search_json to search jsons and identify keys for desired materials.
  • pvdeg.utilities.display_json to view 2 level jsons in Jupyter Notebooks using HTML.

Issue ticket number and link

#118 Requests for this PR functionality
#127 ^^^
#103 Updated versions requirements

Type of change

Please delete options that are not relevant.

  • New feature (non-breaking change which adds functionality)
  • This change requires a documentation update

Checklist before requesting a review

  • I have performed a self-review of my code
  • Code changes are covered by tests.
  • Code changes have been evaluated for compatibility/integration with Scenario analysis (for future PRs)
  • New functions added to init.py
  • API.rst is up to date, along with other sphinx docs pages
  • Example notebooks are rerun and differences in results scrutinized
  • What's new changelog has been updated in the docs

@codecov-commenter
Copy link

Codecov Report

Attention: Patch coverage is 65.75342% with 25 lines in your changes missing coverage. Please review.

Project coverage is 65.65%. Comparing base (0ef212c) to head (f0ba61e).

Files with missing lines Patch % Lines
pvdeg/utilities.py 46.80% 25 Missing ⚠️
Additional details and impacted files
@@               Coverage Diff               @@
##           development     #130      +/-   ##
===============================================
+ Coverage        65.63%   65.65%   +0.02%     
===============================================
  Files               36       36              
  Lines             3477     3549      +72     
===============================================
+ Hits              2282     2330      +48     
- Misses            1195     1219      +24     

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

@martin-springer martin-springer merged commit 2aa7332 into development Oct 25, 2024
6 checks passed
@tobin-ford tobin-ford deleted the materials_access branch December 9, 2024 22:30
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.

3 participants