Adding toroidal harmonic notebooks #3681

clmould · 2024-10-28T16:15:26Z

Linked Issues

(This merge request is updated version of #3645)

Part of #3340

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

sonarqubecloud · 2024-10-28T16:16:30Z

Quality Gate passed

Issues
5 New issues
0 Accepted issues

Measures
0 Security Hotspots
0.0% Coverage on New Code
0.0% Duplication on New Code

See analysis details on SonarCloud

codecov · 2024-10-28T16:32:31Z

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 76.25%. Comparing base (97db428) to head (53ad3a9).

Additional details and impacted files

@@                      Coverage Diff                       @@
##           feature/toroidal-harmonics    #3681      +/-   ##
==============================================================
- Coverage                       76.62%   76.25%   -0.38%     
==============================================================
  Files                             230      231       +1     
  Lines                           27025    27053      +28     
==============================================================
- Hits                            20709    20630      -79     
- Misses                           6316     6423     +107

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

je-cook

From my naive understand looks really good. Could have have some tests for the function going into the main package please?

examples/equilibria/single_wire_field_toroidal_harmonics.ex.py

examples/equilibria/toroidal_harmonics_component_function_verification.ex.py

je-cook · 2024-11-18T08:01:41Z

I was just running our tests on develop and we get a warning from one of the conversion functions (from arccos of a number outside the range -1<x>1 could we add a np.clip to this line unless that would have unintended side effects?

bluemira/bluemira/utilities/tools.py

Line 867 in fcce20f

(d_1**2 + d_2**2 - 4 * R_0**2) / (2 * d_1 * d_2)

to

np.clip((d_1**2 + d_2**2 - 4 * R_0**2) / (2 * d_1 * d_2), -1, 1)

this seem to remove the warning in my quick test. I think its just floating point problems.

- added tests for legendre functions - improved explanations

je-cook

From a code perspective looks good, thanks for adding the tests. A few little things otherwise from my end good to go.

I can't comment on the actual maths maybe @CoronelBuendia or @geograham can comment more?

examples/equilibria/single_wire_field_toroidal_harmonics.ex.py

bluemira/equilibria/optimisation/harmonics/toroidal_harmonics_approx_functions.py

github-actions · 2024-12-13T14:06:40Z

⚠️ Warning Report

Found 3 warnings.

All warnings (3)

On config

/home/runner/miniconda3/envs/bluemira/lib/python3.10/site-packages/pivy/quarter/QuarterWidget.py:17: DeprecationWarning: invalid escape sequence '\C'

On runtest

/home/runner/work/bluemira/bluemira/bluemira/equilibria/find.py:478: DeprecationWarning: Conversion of an array with ndim > 0 to a scalar is deprecated, and will error in future. Ensure you extract a single element from your array before performing this operation. (Deprecated NumPy 1.25.)
/home/runner/work/bluemira/bluemira/bluemira/radiation_transport/radiation_tools.py:886: DeprecationWarning: interp2dis deprecated!interp2d` is deprecated in SciPy 1.10 and will be removed in SciPy 1.12.0.

For legacy code, nearly bug-for-bug compatible replacements are
RectBivariateSpline on regular grids, and bisplrep/bisplev for
scattered 2D data.

In new code, for regular grids use RegularGridInterpolator instead.
For scattered data, prefer LinearNDInterpolator or
CloughTocher2DInterpolator.

For more details see
https://gist.github.com/ev-br/8544371b40f414b7eaf3fe6217209bff
`

geograham

Looks good to go

bluemira/equilibria/optimisation/harmonics/toroidal_harmonics_approx_functions.py

…approx_functions.py Co-authored-by: geograham <[email protected]>

sonarqubecloud · 2024-12-16T09:40:32Z

Quality Gate passed

Issues
4 New issues
0 Accepted issues

Measures
0 Security Hotspots
0.0% Coverage on New Code
0.0% Duplication on New Code

See analysis details on SonarQube Cloud

* add toroidal harmonics approx functions and examples * working on pr comments * changes based on pr review comments - added tests for legendre functions - improved explanations * adding image referenced in singe_wire notebook * changes based on review comments * Update bluemira/equilibria/optimisation/harmonics/toroidal_harmonics_approx_functions.py Co-authored-by: geograham <[email protected]> * Update bluemira/equilibria/optimisation/harmonics/toroidal_harmonics_approx_functions.py Co-authored-by: geograham <[email protected]> --------- Co-authored-by: geograham <[email protected]>

clmould mentioned this pull request Oct 28, 2024

Toroidal harmonic notebooks #3645

Closed

3 tasks

clmould marked this pull request as ready for review October 30, 2024 14:47

clmould requested a review from a team as a code owner October 30, 2024 14:47

je-cook reviewed Nov 4, 2024

View reviewed changes

je-cook added enhancement New feature or request equilibria Tasks relating to the equilibria module labels Nov 4, 2024

geograham requested changes Nov 14, 2024

View reviewed changes

examples/equilibria/single_wire_field_toroidal_harmonics.ex.py Outdated Show resolved Hide resolved

examples/equilibria/single_wire_field_toroidal_harmonics.ex.py Show resolved Hide resolved

examples/equilibria/toroidal_harmonics_component_function_verification.ex.py Show resolved Hide resolved

add toroidal harmonics approx functions and examples

6bc742c

clmould force-pushed the clair/toroidal-approx-nb-single-wire-nb branch from 27871cf to e123fbd Compare December 11, 2024 16:36

clmould requested a review from a team as a code owner December 11, 2024 16:36

clmould added 2 commits December 11, 2024 17:05

working on pr comments

2aef7b7

changes based on pr review comments

582c036

- added tests for legendre functions - improved explanations

clmould force-pushed the clair/toroidal-approx-nb-single-wire-nb branch from e123fbd to 582c036 Compare December 11, 2024 17:06

je-cook approved these changes Dec 12, 2024

View reviewed changes

clmould added 2 commits December 12, 2024 15:47

adding image referenced in singe_wire notebook

9161731

changes based on review comments

549bdab

clmould requested a review from a team as a code owner December 13, 2024 13:51

geograham approved these changes Dec 13, 2024

View reviewed changes

bluemira/equilibria/optimisation/harmonics/toroidal_harmonics_approx_functions.py Outdated Show resolved Hide resolved

bluemira/equilibria/optimisation/harmonics/toroidal_harmonics_approx_functions.py Outdated Show resolved Hide resolved

clmould and others added 2 commits December 16, 2024 09:38

Update bluemira/equilibria/optimisation/harmonics/toroidal_harmonics_…

7818f2e

…approx_functions.py Co-authored-by: geograham <[email protected]>

Update bluemira/equilibria/optimisation/harmonics/toroidal_harmonics_…

53ad3a9

…approx_functions.py Co-authored-by: geograham <[email protected]>

je-cook merged commit 489a202 into Fusion-Power-Plant-Framework:feature/toroidal-harmonics Dec 16, 2024
12 checks passed

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Adding toroidal harmonic notebooks #3681

Adding toroidal harmonic notebooks #3681

clmould commented Oct 28, 2024 •

edited by je-cook

Loading

sonarqubecloud bot commented Oct 28, 2024

codecov bot commented Oct 28, 2024 •

edited

Loading

je-cook left a comment

je-cook commented Nov 18, 2024 •

edited

Loading

je-cook left a comment

github-actions bot commented Dec 13, 2024 •

edited

Loading

On config

On runtest

geograham left a comment

sonarqubecloud bot commented Dec 16, 2024

Adding toroidal harmonic notebooks #3681

Adding toroidal harmonic notebooks #3681

Conversation

clmould commented Oct 28, 2024 • edited by je-cook Loading

Linked Issues

Description

Interface Changes

Checklist

sonarqubecloud bot commented Oct 28, 2024

Quality Gate passed

codecov bot commented Oct 28, 2024 • edited Loading

Codecov Report

je-cook left a comment

Choose a reason for hiding this comment

je-cook commented Nov 18, 2024 • edited Loading

je-cook left a comment

Choose a reason for hiding this comment

github-actions bot commented Dec 13, 2024 • edited Loading

⚠️ Warning Report

On config

On runtest

geograham left a comment

Choose a reason for hiding this comment

sonarqubecloud bot commented Dec 16, 2024

Quality Gate passed

clmould commented Oct 28, 2024 •

edited by je-cook

Loading

codecov bot commented Oct 28, 2024 •

edited

Loading

je-cook commented Nov 18, 2024 •

edited

Loading

github-actions bot commented Dec 13, 2024 •

edited

Loading