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

[POC] 558 delete richdem from source #612

Open
wants to merge 3 commits into
base: branch-poc
Choose a base branch
from

Conversation

vschaffn
Copy link

@vschaffn vschaffn commented Oct 23, 2024

Description

This PR resolves the ticket #558 that requires the removal of the RichDEM dependency from the core functionnality of the xDEM project to ensure the project's license is not impacted by RichDEM's GNU GPL v3.0 license.

The changes made in this PR remove RichDEM from operational code and ensure that RichDEM is only used for testing purposes. Additionally, documentation and contribution guides have been updated to reflect this adjustment.

Changes Implemented

Dependency Management

Updated setup.cfg and dev-environment.yml to move the richdem package from the main optdependencies to the test section.

Source modifications

  • In terrain.py and dem.py, the use_richdem parameter was removed from functions.
  • Any internal helper functions that directly used RichDEM were completely removed.

Tests adjustments

RichDEM is still used in tests to ensure that all attribute functions give the same results as those of RichDEM. The corresponding part of the code that has been removed from source was transfered to conftest.py.

Documentation Updates

  • Updated documentation to reflect the removal of the use_richdem parameter from functions
  • Updated the README to clarify that RichDEM is only used for testing purposes and is not required for the operation of xdem.
  • Added instructions in the contribution gide stating that RichDEM should only be used in tests, and core functionality of xdem must not rely on RichDEM to comply with the license.

Copy link

@adebardo adebardo left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

It seems that there are still occurrences of 'richdem' in the docstrings in the terrain.py file.

README.md Show resolved Hide resolved
tests/test_terrain.py Outdated Show resolved Hide resolved
@adebardo
Copy link

The file dev-environment.yml is missing some modifications.

@vschaffn vschaffn force-pushed the 558-delete_richdem_from_source branch from 3a40b4d to 2b4a009 Compare October 23, 2024 14:59
@adebardo
Copy link

@duboise-cnes @adehecq @rhugonnet it's okay for me, what about you ?

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.

2 participants