Skip to content

Add Healpix grid #162

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.

Sign up for GitHub

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

Jump to bottom
Merged
merged 44 commits into from
Jun 18, 2025
Merged

Add Healpix grid #162

merged 44 commits into from
Jun 18, 2025

Conversation

benbovy
Copy link
Member

@benbovy benbovy commented Jun 18, 2024 •
edited
Loading

  • implement the grid interface
    • grid properties
    • neighbors indices & distances
    • nodes areas
    • nodes status
  • convenient constructors, factories an/or helpers (e.g., construct a grid given a approx. fixed cell resolution)
  • Python bindings
  • ghost node status: skip in flow routers, sink resolvers and eroders
  • node status utility methods (e.g., set continental mask from arbitrary polygons).
  • interpolation utility methods (some requires little work while others may require much more work, not all may be needed)
    • return geodetic or geocentric coordinates of a given cell index, a vector of cell indices or all cells -> useful for mapping field values from an external mesh onto the healpix grid using 3rd-party interpolation
    • return an interpolated value at an arbitrary point (and/or vectorized version), using Healpix's (local) linear interpolation methods -> useful for mapping field values from the Healpix grid onto another mesh of similar resolution
    • return an aggregated field value (mean) for a given bounding box or arbitrary polygon, using Healpix's spatial query methods -> useful for mapping fields values from the Healpix grid onto a coarse grid or mesh.
    • return interpolated values for a given set of arbitrary points using global, point-wise interpolation (spherical harmonics, polynomial fitting) -> useful for mapping fields between different Healpix grids of different resolutions with fine control on the surface smoothing. Might require a lot of work (no high-level method for this available in Healpix, only command-line programs built on top basic functionality, e.g., see smoothing_cxx)
  • configuration
    • FindHealpix CMake module
    • Cmake option to enable / disable Healpix support (opt-in)
  • tests
    • C++ tests
    • Python tests
  • documentation
    • C++ API reference
    • Python API reference
    • User guide
    • Example (at least Python)
  • Python types
  • consider using ducc0 instead of healpix original library (the latter is not supported on Windows), see Gradual migration from Healpix C++ to ducc back-end healpy/healpy#717.
  • Or consider vendoring healpix core code

benbovy added 30 commits June 18, 2024 15:03
@benbovy
add Healpix cmake config + class boilerplate
ca9ab8f
@benbovy
add size and shape implementations
0809724
@benbovy
implement nodes_area
b12b7f1
@benbovy
wip implement neighbors
b3aadb3
@benbovy
implement neighbors
dc68d23
@benbovy
implement nodes_status
97f6c77 
Also add ``fastscapelib::node_status::ghost``
@benbovy
wip python bindings
d4c7d82 
Also use RING scheme (slower for getting the neighbors but more flexible
regarding the choice of the nside value).
@benbovy
add tests
f6bdbcb
@benbovy
disable healpix on windows
f36ba80
@benbovy
cmake older versions compat?
51c0171
@benbovy
fix CI C++ tests healpix skip install win
f3784ca
@benbovy
cmake config: force healpix off on windows
e613085
@benbovy
missing ifdef
2ecce0a
@benbovy
python ignore Healpix import error
bcf5315
@benbovy
forgot remove HealpixGrid import
069eb42
@benbovy
let's set HealpixGrid to None if not supported
93d62cb 
Quick & dirty solution. Alternatively, we could just not define the
class but static checkers may not be happy with dynamically defining
__all__ and we would also need to add a check in fastscapelib's root
__init__. Another alternative is to create another class and raise
within its __init__ method, but that's not great either.
@benbovy
remove gtest and benchmark from conda dev env
e91cda2 
Maybe this will fix googletest link errors? googletest and google
benchmark can be easily build from source as part of the cmake
configuration here.
@benbovy
ignore mypy error
d6e1ef9
@benbovy
ci mypy: install healpix
f1e6223
@benbovy
doc conda env: add healpix
ac19e5b
@benbovy
add nodes_lonlat methods
d7d7d90
@benbovy
add HealpixGrid.__init__ docstrings
91717ac
@benbovy
rename EARTH_RADIUS -> EARTH_RADIUS_METERS
c495217
@benbovy
add nodes_xyz methods + grid nside/radius bindings
41397a7
@benbovy
ci tests: update macos versions
ccf2caf 
macos 11 seems not responsive anymore?
macos 14 for testing on arm64
@benbovy
Merge branch 'main' into healpix-grid
de9be92
@benbovy
ci test numpy 1.xx: disable healpix
c7515da
@benbovy
pip command: try quotes for cmake args
e44766b
@benbovy
Merge branch 'main' into healpix-grid
e832df5
@benbovy
fix compile errors / warnings (xtensor 0.26)
8bac365
@benbovy benbovy marked this pull request as ready for review June 16, 2025 12:49
benbovy added 7 commits June 17, 2025 16:13
@benbovy
doc: add healpix example
ec507ce
@benbovy
python: expose NodeStatus.GHOST
c88a795
@benbovy
doc: add healpy to environment (RTD)
28903a3
@benbovy
python: add NodeStatus.GHOST (types)
9a7daba
@benbovy
doc: planetary example add figure
5dfb10a
@benbovy
pixi: do not install in editable mode
77e8528 
Also add a post-install task (install Fastscapelib with Pip).

There were issues with updating (re-compiling) the package in the
environments before building the doc or running the tests.
@benbovy
doc: add healpix grid in user guide
da27943
@benbovy benbovy merged commit 1e0fe7a into fastscape-lem:main Jun 18, 2025
26 checks passed
@benbovy benbovy mentioned this pull request Jun 18, 2025
Closed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers
No reviews
Assignees
No one assigned
Labels
None yet
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
1 participant
@benbovy