From f454f5b95ef327e4967099aab7ae51ce021dd45f Mon Sep 17 00:00:00 2001 From: ashum9 Date: Wed, 25 Feb 2026 18:34:05 +0530 Subject: [PATCH 1/2] Improve development environment setup instructions --- README.md | 29 +++++++++++++++++++++++++++++ 1 file changed, 29 insertions(+) diff --git a/README.md b/README.md index 9056f0006..fdef4d413 100644 --- a/README.md +++ b/README.md @@ -569,6 +569,35 @@ These files have the same list format as the ones above, but each list has lengt Entries 0 in these lists describe edges between the lowest levels 1 and 2. # Development and Contributing + +## Development Environment Setup + +For development and testing, we recommend creating a clean virtual environment and installing neural-lam in editable mode: + +```bash +python -m venv .venv + +# On Linux/macOS: +source .venv/bin/activate + +# On Windows (Command Prompt): +.venv\Scripts\activate + +# On Windows (PowerShell): +.venv\Scripts\Activate.ps1 + +pip install --group dev -e . +``` + +To verify that the environment is working correctly, run: + +```bash +pytest +``` + +A successful setup should run the full test suite without failures. + +## Code Quality Any push or Pull-Request to the main branch will trigger a selection of pre-commit hooks. These hooks will run a series of checks on the code, like formatting and linting. If any of these checks fail the push or PR will be rejected. From 9e96346959f4f463defde5056dcf732932f323a0 Mon Sep 17 00:00:00 2001 From: ashum9 Date: Mon, 9 Mar 2026 18:17:52 +0530 Subject: [PATCH 2/2] Apply reviewer feedback: update dev setup docs and add changelog entry (#262) --- CHANGELOG.md | 8 ++++++++ README.md | 19 ++++--------------- 2 files changed, 12 insertions(+), 15 deletions(-) diff --git a/CHANGELOG.md b/CHANGELOG.md index 5f9c05c54..cb0fa082c 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -11,6 +11,14 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0 - Fix README image paths to use absolute GitHub URLs so images display correctly on PyPI [\#188](https://github.com/mllam/neural-lam/pull/188) @bk-simon +### Documentation + +- Improve development environment setup instructions in README: link to Python venv docs, clarify editable install with dev dependencies, and add test verification step [\#262](https://github.com/mllam/neural-lam/pull/262) @ashum9 + +### Documentation + +- Improve development environment setup instructions in README: link to Python venv docs, clarify editable install with dev dependencies, and add test verification step [\#262](https://github.com/mllam/neural-lam/pull/262) @ashum9 + - Fix typo in `ar_model.py` that causes `AttributeError` during evaluation [\#204](https://github.com/mllam/neural-lam/pull/204) @ritinikhil - Changed the hardcoded True to a conditional check "persistent_workers=self.num_workers > 0" [\#235](https://github.com/mllam/neural-lam/pull/235) @santhil-cyber diff --git a/README.md b/README.md index 1021151c9..02930a6d0 100644 --- a/README.md +++ b/README.md @@ -572,21 +572,12 @@ Entries 0 in these lists describe edges between the lowest levels 1 and 2. ## Development Environment Setup -For development and testing, we recommend creating a clean virtual environment and installing neural-lam in editable mode: +For development, we recommend using a virtual environment. See the [official Python venv documentation](https://docs.python.org/3/library/venv.html) for instructions on how to set one up. -```bash -python -m venv .venv - -# On Linux/macOS: -source .venv/bin/activate - -# On Windows (Command Prompt): -.venv\Scripts\activate +To install neural-lam in editable mode with development dependencies: -# On Windows (PowerShell): -.venv\Scripts\Activate.ps1 - -pip install --group dev -e . +```bash +python -m pip install --group dev -e . ``` To verify that the environment is working correctly, run: @@ -595,8 +586,6 @@ To verify that the environment is working correctly, run: pytest ``` -A successful setup should run the full test suite without failures. - ## Code Quality Any push or Pull-Request to the main branch will trigger a selection of pre-commit hooks. These hooks will run a series of checks on the code, like formatting and linting.