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

Toroidal harmonic notebooks #3645

Conversation

clmould
Copy link
Contributor

@clmould clmould commented Oct 18, 2024

Linked Issues

Closes #{ID}

Description

Interface Changes

Checklist

I confirm that I have completed the following checks:

  • Tests run locally and pass pytest tests --reactor
  • Code quality checks run locally and pass pre-commit run --from-ref develop --to-ref HEAD
  • Documentation built locally and checked sphinx-build -W documentation/source documentation/build

📚 Documentation preview 📚: https://bluemira--3645.org.readthedocs.build/en/3645/

clmould and others added 27 commits July 5, 2024 10:53
Co-authored-by: je-cook <[email protected]>
Copy link

sonarcloud bot commented Oct 18, 2024

Quality Gate Failed Quality Gate failed

Failed conditions
C Reliability Rating on New Code (required ≥ A)

See analysis details on SonarCloud

Catch issues before they fail your Quality Gate with our IDE extension SonarLint

Copy link

codecov bot commented Oct 18, 2024

Codecov Report

Attention: Patch coverage is 22.22222% with 28 lines in your changes missing coverage. Please review.

Project coverage is 75.96%. Comparing base (3f19183) to head (e11bde1).
Report is 54 commits behind head on feature/toroidal-harmonics.

Files with missing lines Patch % Lines
...n/harmonics/toroidal_harmonics_approx_functions.py 0.00% 28 Missing ⚠️
Additional details and impacted files
@@                      Coverage Diff                       @@
##           feature/toroidal-harmonics    #3645      +/-   ##
==============================================================
+ Coverage                       74.64%   75.96%   +1.31%     
==============================================================
  Files                             231      231              
  Lines                           26871    26749     -122     
==============================================================
+ Hits                            20058    20320     +262     
+ Misses                           6813     6429     -384     

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

Copy link
Contributor

@geograham geograham left a comment

Choose a reason for hiding this comment

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

Just had a discussion with @clmould - will move comments across to the new branch PR and continue review on new PR.

from scipy.special import gamma, poch


def f_hypergeometric(a, b, c, z, n_max):
Copy link
Contributor

Choose a reason for hiding this comment

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

Could we have some tests for these new functions?



def my_legendre_q(lam, mu, x, n_max=20):
"""Evaluates Olver's associated Legendre function of the second kind of degree lambda
Copy link
Contributor

Choose a reason for hiding this comment

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

Oliver is missing an 'i' and should probably use his surname as well, and briefly explain function choice.

documentation/source/utilities/utilities.rst Show resolved Hide resolved
@clmould
Copy link
Contributor Author

clmould commented Oct 28, 2024

This branch is outdated so closing this PR as an updated one has been made #3681

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.

2 participants