docs: update README to recommend uv for dependency management#9
Conversation
shaia
commented
Dec 5, 2025
shaia
commented
- Add uv as recommended package manager for faster installs
- Update development setup instructions with uv venv workflow
- Add uv to requirements section
- Keep pip as fallback option for compatibility
There was a problem hiding this comment.
Pull request overview
This PR updates the README.md to recommend uv as the preferred package manager for faster dependency installation while maintaining pip as a fallback option. The changes modernize the installation instructions and provide more comprehensive development setup guidance.
Key Changes
- Added
uvinstallation instructions across all installation methods (PyPI, source, and development) - Expanded the development setup section with detailed virtual environment creation and activation instructions for multiple platforms
- Updated the requirements section to list
uvas recommended alongsidepip
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
| uv pip install . | ||
| ``` | ||
|
|
||
| Or with a custom library location: | ||
|
|
||
| ```bash | ||
| CFD_ROOT=/path/to/cfd pip install . | ||
| CFD_ROOT=/path/to/cfd uv pip install . | ||
| ``` |
There was a problem hiding this comment.
The "From Source" installation instructions have been changed to exclusively use uv pip install, but unlike the development section (lines 69-72), there's no fallback option provided for users who don't have uv installed. Consider adding a note that users can substitute pip for uv pip if they haven't installed uv yet, or keeping the original pip install examples with uv as an alternative, similar to how it's structured in the "From PyPI" section.
|
|
||
| ### For Development | ||
|
|
||
| We use [uv](https://docs.astral.sh/uv/) for fast dependency management: |
There was a problem hiding this comment.
The documentation recommends using uv for dependency management but doesn't explain how to install uv itself. Consider adding a brief installation instruction or link before this section, such as:
First, install uv if you haven't already:
```bash
pip install uvOr follow the official installation guide.
This will help users who are new to `uv` get started more easily.
- Add uv as recommended package manager for faster installs - Update development setup instructions with uv venv workflow - Add uv to requirements section - Keep pip as fallback option for compatibility
shaia
force-pushed
the
docs/update-readme-uv
branch
from
13eef12 to
6b4f3f1
Compare
