v1.0.0

[trchudley]

• search() function
  • By default (with no index_fpath provided), the search function will now search the PGC dynamic STAC, eliminating the need for a downloaded index files. This is a breaking change - please consult the documentation for how to use the new search() function.
  • years can now take an int as well as a list of ints.
  • Search now additionally includes min_aoi_km2 and is_lsf filtering options option. accuracy now refers to the avg_expected_height_accuracy PGC parameter (previously, it referred to the RMSE), whilst rmse now has its own parameter.
  • The geodataframe returned by search now has additional columns linking to PGC assets (e.g. ‘href_dem’, ‘href_mask’ columns), as well as ‘pdt_’ columns that provide consistent column naming between the STAC- and index-returned dataframes.
• Coregistration
  • .pdt.coregister() has now been split into two functions: coregister_dems() and coregister_is2().
  • coregister_dems() is the old coregister() function (which is retained as a deprecated function, redirecting to coregister_dems(). coregister_is2() is a new function that takes ICESat-2 reference data rather than a reference DEM. More information about this feature is included in the updated documentation.
  • Behind the scenes, both coregistration functions use the same background function - slight editing of the function has been done to accommodate both gridded and point reference data.
  • Coregistration now returns metadata as a single metadata dictionary when returns_stats is True.
  • Coregistration functions include a new ‘verbose’ option allow the minimisation of output if desired, defaults to True.
• data module
  • A new icesat2_atl06() function is included to download contemporaneous ICESat-2 data, wrapping the sliderule Python package. This is designed to streamline the ICESat-2 coregistration process. More information is included in the updated documentation.
• load module
  • Load functions now include a ‘pad’ option, to make outputs the full size of the bounds (filled with NaNs) even when the strips are smaller.
  • The preview() function now makes applying the PGC bitmask optional, with the new bitmask parameter defaulting to True.
• terrain module
  • pdt.terrain() now has a default attribute of ‘all’
  • pdt.terrain() now has additional plan_curvature, vertical_excess, and horizontal_excess curvature
• Documentation
  • Examples have been updated to explain new functionality (the STAC search and ICESat-2 coregistration).. Some notebooks have been split (e.g. mosaic download and terrain analysis) in the interests of providing more focussed explanations of tasks.
  • The default plotting now shown in the documentation is xda.plot.imshow(): it’s a lot quicker than the default xarray xda.plot(). Option.
• Batch scripts
  • The batch script has been updated with additional functionality to integrate custom geoids and masks, and has been split into two scripts: *_dem.py for DEM-based coregistration, and *_is2.py for ICESat-2-based coregistration.
    Various minor bug fixes and code cleaning occurs throughout.