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

Test Documentation #92

Merged
merged 163 commits into from
Jul 12, 2024
Merged

Test Documentation #92

merged 163 commits into from
Jul 12, 2024

Conversation

MAfarrag
Copy link
Member

@MAfarrag MAfarrag commented Jun 19, 2024

Description

Dataset

  • add close method to flush to desk and close a dataset.
  • add add_band method to add an array as a band to an existing dataset.
  • rename pivot_point to top_left_corner in the create method.
  • the to_file method return a Dataset object pointing to the saved dataset rather than the need to re-read the
    saved dataset after you save it.

Deprecated

*Cropping a raster using a polygon is done now directly using gdal.wrap nand the the _crop_with_polygon_by_rasterizing
is deprecated.

  • rename the interpolation method nearest neighbour to nearest neighbor.
  • Fixes # (issue)

Type of change

Check relevant points.

  • Bug fix (non-breaking change which fixes an issue)
  • New feature (non-breaking change which adds functionality)
  • Breaking change (fix or feature that would cause existing functionality to not work as expected)
  • This change requires a documentation update

How Has This Been Tested?

  • modify TestCreateRasterObject::test_create_from_Array.
  • modify TestCreateRasterObject::test_copy.
  • add all the tests in the TestAddBand test class.
  • add TestCrop::test_crop_multi_band_dataset_with_multi_band_mask.
  • add TestCropWithPolygon::test_by_warp_touch_true_multi_band
  • add TestToFeatureCollection::test_tiling
  • add TestExtract::test_multi_band_with_mask.
  • add TestClustering::test_generated_data.
  • add test_nearest_neigbors.
  • add TestColorTable::test_generated_data

Checklist:

  • updated version number in setup.py/pyproject.toml.
  • updated environment.yml and the lock file.
  • added changes to History.rst.
  • updated the latest version in README file.
  • I have added tests that prove my fix is effective or that my feature works.
  • New and existing unit tests pass locally with my changes.
  • documentation are updated.

Copy link

codecov bot commented Jun 19, 2024

Codecov Report

Attention: Patch coverage is 63.63636% with 4 lines in your changes missing coverage. Please review.

Project coverage is 87.20%. Comparing base (585d339) to head (509d2a4).
Report is 3 commits behind head on main.

Files Patch % Lines
pyramids/netcdf.py 20.00% 4 Missing ⚠️
Additional details and impacted files
@@            Coverage Diff             @@
##             main      #92      +/-   ##
==========================================
+ Coverage   85.82%   87.20%   +1.37%     
==========================================
  Files           6       10       +4     
  Lines        1976     2657     +681     
==========================================
+ Hits         1696     2317     +621     
- Misses        280      340      +60     

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

@MAfarrag MAfarrag added documentation Improvements or additions to documentation dataset labels Jul 11, 2024
@MAfarrag MAfarrag merged commit 1dd2e24 into main Jul 12, 2024
8 checks passed
@MAfarrag MAfarrag deleted the dataset/doctest branch July 12, 2024 12:18
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
dataset documentation Improvements or additions to documentation
Projects
None yet
Development

Successfully merging this pull request may close these issues.

1 participant