Skip to content

Commit

Permalink
Simplify development installation (#198)
Browse files Browse the repository at this point in the history
* add all optional dependencies to dev requirements

* update contributing guide

* update PR test action
  • Loading branch information
ziw-liu authored Oct 30, 2024
1 parent f44f568 commit 1cb0fc2
Show file tree
Hide file tree
Showing 3 changed files with 4 additions and 5 deletions.
2 changes: 1 addition & 1 deletion .github/workflows/pr.yml
Original file line number Diff line number Diff line change
Expand Up @@ -33,6 +33,6 @@ jobs:
python -m pip install --upgrade pip
# Install cpu wheels only to speed up the build
pip install torch torchvision --index-url https://download.pytorch.org/whl/cpu
pip install ".[metrics,dev]"
pip install ".[dev]"
- name: Test with pytest
run: pytest -v
4 changes: 2 additions & 2 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,11 +3,11 @@
## Development installation

Clone or fork the repository,
then make an editable installation with all the optional dependencies:
then make an editable installation with all the development dependencies:

```sh
# in project root directory (parent folder of pyproject.toml)
pip install -e ".[dev,visual,metrics]"
pip install -e ".[dev]"
```

## CI requirements
Expand Down
3 changes: 1 addition & 2 deletions pyproject.toml
Original file line number Diff line number Diff line change
Expand Up @@ -41,7 +41,6 @@ metrics = [
"captum>=0.7.0",
]
examples = ["napari", "jupyter", "jupytext"]

visual = [
"ipykernel",
"graphviz",
Expand All @@ -51,8 +50,8 @@ visual = [
"nbformat",
"cmap",
]

dev = [
"viscy[metrics,examples,visual]",
"pytest",
"pytest-cov",
"hypothesis",
Expand Down

0 comments on commit 1cb0fc2

Please sign in to comment.