Skip to content

Commit f078b67

Browse files
committed
remove checkm2 github link in main deps to be able to deploy in Pypi and update doc
1 parent 0f8b1ca commit f078b67

2 files changed

Lines changed: 11 additions & 2 deletions

File tree

docs/installation.md

Lines changed: 7 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -68,8 +68,14 @@ Binette is available on [PyPI](https://pypi.org/project/Binette/) and can be ins
6868
pip install binette
6969
```
7070

71-
In addition to Python dependencies, Binette requires [Diamond](https://github.com/bbuchfink/diamond) to be installed and executable.
71+
In addition to Python dependencies, Binette requires a few external tools:
7272

73+
* **[DIAMOND](https://github.com/bbuchfink/diamond)** must be installed and available in your system’s `PATH`.
74+
* **[CheckM2](https://github.com/chklovski/CheckM2)** (version `1.1.0`) is also required but not distributed on PyPI. You can install it directly from GitHub:
75+
76+
```bash
77+
pip install git+https://github.com/chklovski/CheckM2.git@1.1.0
78+
```
7379

7480
## Downloading the CheckM2 database
7581

pyproject.toml

Lines changed: 4 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -25,7 +25,6 @@ classifiers=[
2525
requires-python = ">=3.12"
2626

2727
dependencies = [
28-
"checkm2 @ git+https://github.com/chklovski/CheckM2.git@1.1.0",
2928
"joblib>=1.0,<2.0",
3029
"networkx>=3.0,<4.0",
3130
"numpy>1.24,<3.0",
@@ -39,6 +38,10 @@ dependencies = [
3938

4039
[project.optional-dependencies]
4140

41+
checkm2 = [
42+
"checkm2 @ git+https://github.com/chklovski/CheckM2.git@1.1.0"
43+
]
44+
4245
doc = [
4346
"sphinx==6.2.1",
4447
"sphinx_rtd_theme==1.2.2",

0 commit comments

Comments
 (0)