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 interpolation argument documentation #549

Conversation

tjhei
Copy link
Contributor

@tjhei tjhei commented Feb 13, 2024

also see #547

Copy link
Member

@MFraters MFraters left a comment

Choose a reason for hiding this comment

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

one small comment, otherwise good to go.

"distance parameter. Options are global, none, linear, monotone spline and "
"continuous monotone spline interpolation. If this "
"distance parameter. Options are 'global' and "
"'continuous monotone spline' interpolation. If this "
Copy link
Member

Choose a reason for hiding this comment

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

Could you add a note here that this parameter is deprecated?

Copy link
Contributor Author

Choose a reason for hiding this comment

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

is this because the global one is also only "continuous monotone spline"?

Copy link
Member

Choose a reason for hiding this comment

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

yes, and I probably want to get rid of this option before the 1.0 release.

Copy link

codecov bot commented Feb 13, 2024

Codecov Report

All modified and coverable lines are covered by tests ✅

Comparison is base (1ae31ff) 93.49% compared to head (9a62a04) 93.55%.
Report is 56 commits behind head on main.

Additional details and impacted files

Impacted file tree graph

@@            Coverage Diff             @@
##             main     #549      +/-   ##
==========================================
+ Coverage   93.49%   93.55%   +0.05%     
==========================================
  Files          92       92              
  Lines        6346     6343       -3     
==========================================
+ Hits         5933     5934       +1     
+ Misses        413      409       -4     
Files Coverage Δ
source/world_builder/features/interface.cc 97.77% <ø> (ø)

... and 3 files with indirect coverage changes


Continue to review full report in Codecov by Sentry.

Legend - Click here to learn more
Δ = absolute <relative> (impact), ø = not affected, ? = missing data
Powered by Codecov. Last update 1ae31ff...9a62a04. Read the comment docs.

Copy link

github-actions bot commented Feb 13, 2024

Benchmark Main Feature Difference (99.9% CI)
Slab interpolation simple none 1.023 ± 0.004 (s=413) 1.023 ± 0.004 (s=469) -0.1% .. +0.1%
Slab interpolation curved simple none 1.026 ± 0.003 (s=454) 1.026 ± 0.002 (s=426) -0.0% .. +0.1%
Spherical slab interpolation simple none 1.249 ± 0.012 (s=332) 1.243 ± 0.013 (s=393) -0.7% .. -0.2%
Slab interpolation simple curved CMS 1.098 ± 0.008 (s=407) 1.100 ± 0.007 (s=414) +0.0% .. +0.3%
Spherical slab interpolation simple CMS 1.864 ± 0.007 (s=236) 1.861 ± 0.005 (s=250) -0.2% .. -0.1%
Spherical fault interpolation simple none 1.272 ± 0.005 (s=362) 1.269 ± 0.004 (s=349) -0.4% .. -0.2%
Cartesian min max surface 2.415 ± 0.018 (s=205) 2.416 ± 0.018 (s=170) -0.2% .. +0.3%
Spherical min max surface 7.359 ± 0.016 (s=61) 7.362 ± 0.023 (s=64) -0.1% .. +0.2%

@tjhei tjhei force-pushed the update-interpolation-parameter-documentation branch from f7f20a8 to 9a62a04 Compare February 14, 2024 03:47
@tjhei
Copy link
Contributor Author

tjhei commented Feb 14, 2024

updated.

@MFraters MFraters merged commit 7ddaa71 into GeodynamicWorldBuilder:main Feb 14, 2024
34 checks passed
@tjhei tjhei deleted the update-interpolation-parameter-documentation branch February 14, 2024 21:38
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