You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
docs: update documentation for uv package management
Update developer documentation to use uv as primary package manager:
- Add uv installation instructions to for-developers.md
- Update REPO-GUIDELINES.md with uv sync/run commands
- Add uv run prefixes to tool commands in tools.md
Copy file name to clipboardExpand all lines: docs/getting-started/for-developers.md
+46-24Lines changed: 46 additions & 24 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -10,53 +10,75 @@ python3 --version
10
10
11
11
**Note:** The project specifically requires Python 3.12+ to utilise advanced typing features and maintain compatibility with the latest scientific computing libraries.
12
12
13
-
## Create a Virtual Environment
13
+
## Install uv (Recommended)
14
14
15
-
It is strongly recommended that you install SmartEM Decisions within a virtual environment to prevent conflicts with existing Python installations and maintain a clean development environment:
15
+
We recommend using [uv](https://docs.astral.sh/uv/) for Python package management. uv is a fast Python package manager that handles virtual environments and dependencies efficiently.
16
+
17
+
### Install uv
16
18
17
19
```bash
18
-
python3 -m venv /path/to/venv
19
-
source /path/to/venv/bin/activate
20
+
# On macOS and Linux
21
+
curl -LsSf https://astral.sh/uv/install.sh | sh
22
+
23
+
# Or with pip
24
+
pip install uv
25
+
26
+
# Or with Homebrew (macOS)
27
+
brew install uv
20
28
```
21
29
22
-
For development work, consider creating the virtual environment within the project directory:
30
+
## Installing the Library
31
+
32
+
### Development Installation (Recommended)
33
+
34
+
For development work, clone the repository and install using uv:
0 commit comments