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

update examples and docs for RdTools 3 #429

Merged
merged 39 commits into from
Oct 17, 2024

Conversation

mdeceglie
Copy link
Collaborator

@mdeceglie mdeceglie commented Sep 17, 2024

  • Code changes are covered by tests
  • Code changes have been evaluated for compatibility/integration with TrendAnalysis
  • 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
  • Updated changelog

@mdeceglie mdeceglie marked this pull request as draft September 17, 2024 15:53
@mdeceglie
Copy link
Collaborator Author

To do: Get the example file on the DuraMAT datahub updated to include the NSRDB data

@codecov-commenter
Copy link

codecov-commenter commented Sep 17, 2024

Codecov Report

Attention: Patch coverage is 77.77778% with 2 lines in your changes missing coverage. Please review.

Project coverage is 96.10%. Comparing base (a46b348) to head (e916cd3).

Files with missing lines Patch % Lines
rdtools/soiling.py 75.00% 2 Missing ⚠️
Additional details and impacted files
@@                      Coverage Diff                       @@
##           aggregated_filters_for_trials     #429   +/-   ##
==============================================================
  Coverage                          96.10%   96.10%           
==============================================================
  Files                                 11       11           
  Lines                               2208     2209    +1     
==============================================================
+ Hits                                2122     2123    +1     
  Misses                                86       86           

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

@mdeceglie
Copy link
Collaborator Author

@martin-springer @kandersolar Any ideas on how I managed to break the nbval tests here?

@martin-springer
Copy link
Collaborator

martin-springer commented Sep 25, 2024

@martin-springer @kandersolar Any ideas on how I managed to break the nbval tests here?

@mdeceglie - A missing comma in the workflow file and upload-artifact had to be updated to v4.

There's an issue tough with the newer version of nbval ignoring the semicolon: computationalmodelling/nbval#194

Unfortunately, that bug hasn't been fixed in 0.11 either. We need to decide on how we want to address that.

@mdeceglie
Copy link
Collaborator Author

mdeceglie commented Oct 14, 2024

@kandersolar Is it time to remove the experimental warning from the availability module? Seems pretty locked in, we've used it in a number of different applications successfully, and I'm not aware of plans to modify it.

@kandersolar
Copy link
Member

I have no plans to change the method either. No objection from me on removing the warning.

@mdeceglie mdeceglie marked this pull request as ready for review October 16, 2024 21:02
Copy link
Collaborator

@martin-springer martin-springer left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Looking great! I only found a few minor things.

docs/sphinx/source/index.rst Outdated Show resolved Hide resolved
rdtools/bootstrap.py Outdated Show resolved Hide resolved
rdtools/soiling.py Show resolved Hide resolved
docs/TrendAnalysis_example.ipynb Outdated Show resolved Hide resolved
docs/degradation_and_soiling_example.ipynb Outdated Show resolved Hide resolved
@mdeceglie mdeceglie merged commit 62ff1d9 into aggregated_filters_for_trials Oct 17, 2024
19 checks passed
@mdeceglie mdeceglie deleted the new_notebooks branch October 17, 2024 16:28
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.

4 participants