From ddaf2a8ea41efb97b07814d339aa0f3e618e2492 Mon Sep 17 00:00:00 2001 From: saun09 Date: Sat, 3 Jan 2026 18:07:55 +0530 Subject: [PATCH] docs: clarify installation steps and add Windows test instructions --- README.md | 17 ++++++++++++++++- 1 file changed, 16 insertions(+), 1 deletion(-) diff --git a/README.md b/README.md index 2e5d60c4..f3d51d28 100644 --- a/README.md +++ b/README.md @@ -38,9 +38,23 @@ Instead of trying to accommodate for all these differences and make all the sour You can install **ocf-data-sampler** for development as follows: +1. **Clone the repository:** ``` pip install git+https://github.com/openclimatefix/ocf-data-sampler.git ``` +2. **Set up a virtual environment**: +``` +python -m venv venv +.\venv\Scripts\activate +``` +3. **Install with development dependencies:** +``` +pip install -e ".[dev]" +``` +4. **Manual Dask Installation : If you encounter a ModuleNotFoundError: No module named 'dask':** +``` +pip install dask[complete] +``` ### Running the test suite @@ -48,8 +62,9 @@ The tests in this project use `pytest`. Once you have it installed, you can run ``` cd ocf-data-sampler -pytest +pytest ``` +Use ```python -m pytest``` to run tests via the python module ## Contributing and community