Skip to content

Commit 970c17d

Browse files
committed
Add instructions to clone protein-quest repo
Fixes #58
1 parent 58ab11b commit 970c17d

File tree

2 files changed

+8
-0
lines changed

2 files changed

+8
-0
lines changed

CONTRIBUTING.md

Lines changed: 7 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -31,6 +31,13 @@ The sections below outline the steps in each case.
3131
1. (**important**) announce your plan to the rest of the community *before you start working*. This announcement should be in the form of a (new) issue;
3232
1. (**important**) wait until some kind of consensus is reached about your idea being a good idea;
3333
1. if needed, fork the repository to your own Github profile and create your own feature branch off of the latest main commit. While working on your feature branch, make sure to stay up to date with the main branch by pulling in changes, possibly from the 'upstream' repository (follow the instructions [here](https://help.github.com/articles/configuring-a-remote-for-a-fork/) and [here](https://help.github.com/articles/syncing-a-fork/));
34+
1. clone the [protein-quest](https://github.com/haddocking/protein-quest) repository into the parent directory (one level up from protein-detective) as protein-detective depends on it in editable/development mode:
35+
```shell
36+
cd ..
37+
git clone git@github.com:haddocking/protein-quest.git
38+
cd protein-detective
39+
```
40+
Note: Since protein-quest is installed in editable mode, any changes you make to its code will be immediately available in protein-detective without requiring a reinstall.
3441
1. install [uv](https://docs.astral.sh/uv) to manage this packages development environment);
3542
1. Make sure `uv sync && . .venv/bin/activate && protein-detective --help` works;
3643
1. make sure the existing tests still work by running `uv run pytest`;

benchmark/stats.py

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,5 @@
11
"""Script to print some statistics about the (partially) completed datasets."""
2+
23
# ruff: noqa: T201 this is a script
34
from os import listdir
45
from pathlib import Path

0 commit comments

Comments
 (0)