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

Features to finalize before v1.0 #361

Open
5 of 28 tasks
rhugonnet opened this issue Apr 13, 2023 · 0 comments
Open
5 of 28 tasks

Features to finalize before v1.0 #361

rhugonnet opened this issue Apr 13, 2023 · 0 comments
Assignees
Labels
enhancement Feature improvement or request

Comments

@rhugonnet
Copy link
Member

rhugonnet commented Apr 13, 2023

Before releasing a first 1.0:

  • Check all documentation thoroughly,
  • Check syntax + homogenization aspects covered in Docs are fulfilled.

Documentation:

  • Add nice example data for the "Quick start",
  • Add geographic example data (lat/lon) for demonstrating metric functionalities in "Projection tools" (and for tests),
  • Add interactive plotting? (optional but would be nice),
  • Add Binder to run the documentation pages in Jupyter notebooks,
  • Figure out why logo's SVG does not always render correctly (fixed in Write documentation and streamline general behaviour #351, see Revert default_mode of html_context to auto once Pydata Sphinx Theme is updated #362),
  • Add links to mini-galleries in the feature documentation (to have more illustrated examples),
  • Add section about point interpretation for Raster.
  • Improve API: order alphabetically, include missing submodules, e.g. projtools.
  • Document CLI tools (currently only geoviewer.py). -> solved by Fix several issues in geoviewer #418
  • Finalize "Mask from a vector" example once rasterizing with geoparameters functionality consistently added to create_mask (see "Improvements" below),
  • Remove output of "Axes" in the "Reduction from window" and "Interpolation from grid" example,
  • Replace bit of code with Vector function in "Interpolation from grid" example.

Bugs:

  • Nodata are plotted for GeoDataFrame (see "Interpolation from grid" example),
  • Colorbar is wrong for Vector.show()
  • Polygonizing "all" values on the Landsat_B4 example creates some LineString inside polygon?

Tests:

  • Further increase coverage of vector.py (save, getitem, etc, see Coveralls report),
  • Logically catch all warnings triggered during tests.

Improvements:

  • Homogenize array shape input/output of interp_points and value_at_coords, and variable names. Make output shape consistent for interp_points and others: if single-coordinate float is passed, return the same. Otherwise, if ArrayLike is passed, return ArrayLike. Could create a generic function for dealing with points: accept a Vector of type point, accept any shape of input list or array, and use it everywhere?
  • Homogenize naming of "match-reference" everywhere: right now sometimes dst_ref, sometimes rst, sometimes raster_or_vector,
  • Overload Mask.show to only a discontinuous, 2-color colorbar (with interpolation="none"),
  • Consistently allow having only shape or res as argument for Vector rasterizing methods (rasterize, create_mask, proximity),
  • Make info() method directly print (to avoid having to call print(rast.info())?). -> solved in Raster downsampling and cropping operations seem to be incompatible #408

New features:

  • A Vector random point generation in an outline, can pass a Raster object as match-reference to get a random point in its extent.
  • Add mask options for window of value_at_coords (disk, etc),
  • Add from_points method for Raster,
  • Add zonal statistics (see how it is done in rasterstats?).
@rhugonnet rhugonnet added the enhancement Feature improvement or request label Apr 13, 2023
@rhugonnet rhugonnet changed the title Features to finalize before v0.1 Features to finalize before v1.0 Sep 25, 2023
@rhugonnet rhugonnet changed the title Features to finalize before v1.0 Features to finalize before v0.1 Jan 16, 2024
@rhugonnet rhugonnet changed the title Features to finalize before v0.1 Features to finalize before v1.0 Jan 16, 2024
@atedstone atedstone moved this from Todo to In Progress in Hack - Jan 2024 - Geoutils Version Release Jan 18, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
enhancement Feature improvement or request
Projects
Development

No branches or pull requests

3 participants