docs: clarify installation steps and add Windows test instructions #387
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Pull Request
Description
This PR updates the development installation guide in the README to improve the onboarding experience, specifically for Windows users.
Motivation:
While setting up my local environment, I encountered a
ModuleNotFoundErrorfordaskand pathing issues with the globalpytestcommand. This update clarifies the setup process and ensures new contributors can get the test suite running quickly.Changes:
pip install dask[complete].python -m pytestto ensure the local environment's dependencies are used.How Has This Been Tested?
I followed the updated instructions on a Windows 11 machine within a fresh virtual environment.
Successfully installed dependencies using
pip install -e ".[dev]".Verified that
daskwas correctly recognized after the troubleshooting step.Ran the full test suite using
python -m pytest.Yes (Verified 82 tests passed)
If your changes affect data processing, have you plotted any changes?
Checklist: