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

Wrap all functionalities as DEM methods #478

Merged
merged 9 commits into from
Mar 4, 2024

Conversation

rhugonnet
Copy link
Contributor

@rhugonnet rhugonnet commented Feb 24, 2024

This PR:

  • Adds all of xDEM's methods as wrappers in the DEM class, for instance DEM.slope(), DEM.coregister_3d(), DEM.estimate_uncertainty(),
  • Adds tests to check these run correctly (simple comparison to outputs of module functions),
  • Adds a copy_doc decorator in misc.py that allows to copy the docstring of terrain function descriptions in the DEM class without having to re-write it all,
  • Adds to the documentation a new "Elevation data objects" section containing a "The digital elevation model" page that describes the DEM object (and soon an "Elevation point cloud", and "Xarray DEM accessor"),
  • Adds a "Quick use" subsection on the pages "Coregistration" and "Terrain attributes" to mention the options of calling the functions from a DEM, or to use the module directly,
  • Updates the "Spatial statistics" page into an "Uncertainty analysis" page, in preparation for Re-structure spatialstats.py #378,
  • Updates the API of xDEM to mirror part of GeoUtils, or point towards it.

Resolves #474
Partially addresses #275

I will further improve the uncertainty analysis page in #378, and we can improve the one of the coregistration after our hackathon! Then we'll be close to a fully populated and homogeneous documentation for a v0.1! 😄

@rhugonnet
Copy link
Contributor Author

Ready to merge, other documentation change will take place in future PRs.
Maybe the most efficient is to review the entire documentation at once it's over? By default it won't be visible for users until we release a new version (will be accessible in latest, but stable is the default one).

@rhugonnet rhugonnet marked this pull request as ready for review February 28, 2024 23:07
@rhugonnet rhugonnet merged commit e3feeed into GlacioHack:main Mar 4, 2024
13 checks passed
@rhugonnet rhugonnet deleted the dem_class_wrapper_methods branch March 4, 2024 20:41
@rhugonnet
Copy link
Contributor Author

Functions already tested, only wrappers. And for the documentation, let's review all at once before the first minor release, it'll be more practical!
Merging.

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.

Add wrappers for all features (terrain, coregistration) as DEM class methods
1 participant