Problem
While setting up the neural-lam development environment locally, I ran
into dependency compatibility issues that caused the test suite to fail.
In particular:
- xarray <= 2025.4.0 caused failures with zarr v3 datastores
- dependency versions required for a working development environment
are not clearly documented
Although these issues can be resolved, the setup process can be confusing
for new contributors.
Proposal
Add a short "Development Environment" section to the README that includes:
- Instructions for creating a virtual environment
- Installing neural-lam in editable mode
- Running the test suite
- Example of a working dependency configuration
This would make it easier for new contributors to set up the project and
start contributing.
Context
I recently set up the development environment and ran the full test suite
successfully:
pytest
110 passed, 0 failed
I would be happy to work on improving the documentation if this approach
sounds reasonable.
Problem
While setting up the neural-lam development environment locally, I ran
into dependency compatibility issues that caused the test suite to fail.
In particular:
are not clearly documented
Although these issues can be resolved, the setup process can be confusing
for new contributors.
Proposal
Add a short "Development Environment" section to the README that includes:
This would make it easier for new contributors to set up the project and
start contributing.
Context
I recently set up the development environment and ran the full test suite
successfully:
I would be happy to work on improving the documentation if this approach
sounds reasonable.