Skip to content

docs: update README to recommend uv for dependency management #9

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
shaia merged 1 commit into from
Dec 5, 2025
Merged

docs: update README to recommend uv for dependency management #9

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
53 changes: 50 additions & 3 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -12,7 +12,30 @@ Python bindings for high-performance CFD simulation library using CPython C-API

## Installation

### From PyPI (Recommended)
### Installing uv (optional but recommended)

[uv](https://docs.astral.sh/uv/) is a fast Python package manager. Install it with:

```bash
# On macOS/Linux
curl -LsSf https://astral.sh/uv/install.sh | sh

# On Windows
powershell -ExecutionPolicy ByPass -c "irm https://astral.sh/uv/install.ps1 | iex"

# Or with pip
pip install uv
```

### From PyPI

Using uv (recommended):

```bash
uv pip install cfd-python
```

Or with pip:

```bash
pip install cfd-python
Expand All @@ -37,16 +60,39 @@ The Python package requires the C CFD library to be built first. By default, it
pip install .
```

Or with a custom library location:
Or with [uv](https://docs.astral.sh/uv/) for faster installs:

```bash
uv pip install .
```

With a custom library location:

```bash
CFD_ROOT=/path/to/cfd pip install .
```

### For Development

We use [uv](https://docs.astral.sh/uv/) for fast dependency management:
Copy link

Copilot AI Dec 5, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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 uv

Or follow the official installation guide.


This will help users who are new to `uv` get started more easily.

Copilot uses AI. Check for mistakes.

```bash
# Create virtual environment
uv venv

# Activate it
source .venv/bin/activate # Linux/macOS
source .venv/Scripts/activate # Windows (Git Bash)
.venv\Scripts\activate # Windows (cmd)

# Install with dev dependencies
uv pip install -e ".[test,dev]"
```

Alternatively, using pip:

```bash
pip install -e .
pip install -e ".[test,dev]"
```

## Quick Start
Expand Down Expand Up @@ -196,6 +242,7 @@ cfd_python.OUTPUT_CSV_STATISTICS # Global statistics (CSV)
## Requirements

- Python 3.8+
- [uv](https://docs.astral.sh/uv/) (recommended) or pip

For building from source:

Expand Down
Loading