Skip to content

Commit 047ff2f

Browse files
committed
Update development documentation to use uv
1 parent 17bc020 commit 047ff2f

File tree

1 file changed

+19
-8
lines changed

1 file changed

+19
-8
lines changed

README.md

Lines changed: 19 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -27,20 +27,33 @@ documentation. See the [ERT](https://github.com/equinor/ert) documentation for e
2727
how to run workflows and forward models, and build the [ERT](https://github.com/equinor/ert) documentation to get
2828
documentation for the workflows and forward models.
2929

30+
## Developing
31+
32+
We use uv to have one synchronized development environment for all packages.
33+
See [installing uv](https://docs.astral.sh/uv/getting-started/installation/). We
34+
recommend installing uv using your system's package manager, or into a small
35+
dedicated virtual environment.
36+
37+
Once uv is installed, you can get a development environment by running:
38+
39+
```sh
40+
git clone https://github.com/equinor/semeio
41+
cd semeio
42+
uv sync --all-groups --all-extras
43+
```
44+
3045
# Run tests
3146
To run the full test suite, do:
3247

3348
```sh
34-
pip install ".[test]"
35-
pytest tests
49+
uv run pytest tests
3650
```
3751

3852
[pre-commit](https://pre-commit.com/) is used to comply with the formatting standards.
3953
The complete formatting tests can be run with:
4054

4155
```sh
42-
pip install ".[style]"
43-
pre-commit run --all-files
56+
uv run pre-commit run --all-files
4457
```
4558

4659
Formatting use `ruff`, See `.pre-commit-config.yaml` for the
@@ -51,15 +64,13 @@ to avoid committing with formatting errors. This will only run on the diff so is
5164
To configure this, run:
5265

5366
```sh
54-
pip install ".[style]"
55-
pip install pre-commit
56-
pre-commit install
67+
uv run pre-commit install
5768
```
5869

5970
After this the hook will run on every commit.
6071

6172
If you would like to remove the hooks, run:
6273

6374
```sh
64-
pre-commit uninstall
75+
uv run pre-commit uninstall
6576
```

0 commit comments

Comments
 (0)