Skip to content

Commit c5411f9

Browse files
committed
DOC Update installation docs
1. Recommend pixi 2. Do not recommend fraggenescan
1 parent 21157db commit c5411f9

File tree

2 files changed

+73
-18
lines changed

2 files changed

+73
-18
lines changed

README.md

Lines changed: 21 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -24,7 +24,8 @@ well as their benchmarking) are described in
2424

2525
A tutorial of running SemiBin from scrath can be found here [SemiBin tutorial](https://github.com/BigDataBiology/SemiBin_tutorial_from_scratch).
2626

27-
Installation:
27+
28+
Installation with `conda`:
2829

2930
```bash
3031
conda create -n SemiBin
@@ -59,20 +60,29 @@ Please find more options and details below and [read the docs](https://semibin.r
5960

6061
SemiBin runs (and is continuously tested) on Python 3.7-3.13
6162

62-
### Bioconda
63+
### pixi
6364

64-
The simplest mode is shown above.
65-
However, if you want to use SemiBin with GPU (which is faster if you have one available), you need to install PyTorch with GPU support:
65+
The current recommended way to install SemiBin with GPU-support is to use [pixi](https://pixi.sh/). Pixi will use the packages from conda-forge and bioconda to install SemiBin and its dependencies. See [the docs](https://semibin.readthedocs.io/en/latest/install/) for more details, but the basic idea is to create a `pixi.toml` file with the following content:
6666

67-
```bash
68-
conda create -n SemiBin
69-
conda activate SemiBin
70-
conda install -c conda-forge -c bioconda semibin
71-
conda install -c pytorch -c nvidia pytorch pytorch-cuda=11.8
67+
```toml
68+
[project]
69+
authors = ["Luis Pedro Coelho <luis@luispedro.org>"]
70+
channels = ["conda-forge", "bioconda"]
71+
name = "semibin_install"
72+
platforms = ["linux-64"]
73+
version = "0.1.0"
74+
75+
[tasks]
76+
77+
[dependencies]
78+
semibin = ">=2.1.0,<3"
79+
pytorch-gpu = "*"
80+
81+
[system-requirements]
82+
cuda = "12.0"
7283
```
7384

74-
_MacOS note_: **you can only install the CPU version of PyTorch in MacOS with `conda` and you need to install from source to take advantage of a GPU** (see [#72](https://github.com/BigDataBiology/SemiBin/issues/72)).
75-
For more information on how to install PyTorch, see [their documentation](https://pytorch.org/get-started/locally/).
85+
This will install SemiBin with GPU support, but it does require a CUDA-compatible GPU. Alternatively, you can install SemiBin in CPU-only mode by removing the `pytorch-gpu` and `cuda` lines.
7686

7787
### Source
7888

docs/install.md

Lines changed: 52 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -1,12 +1,60 @@
11
# Install
22

3-
SemiBin can run on Python 3.7-3.12.
3+
SemiBin can run on Python 3.7-3.13.
4+
5+
## Install with pixi
6+
7+
The current recommended way to install SemiBin is to use [pixi](https://pixi.sh/). Pixi will use the packages from conda-forge and bioconda to install SemiBin and its dependencies.
8+
9+
### CPU-only mode
10+
11+
Create a `pixi.toml` file with the following content.
12+
13+
```toml
14+
[project]
15+
authors = ["Luis Pedro Coelho <luis@luispedro.org>"]
16+
channels = ["conda-forge", "bioconda"]
17+
name = "semibin_install"
18+
platforms = ["linux-64", "osx-64"]
19+
version = "0.1.0"
20+
21+
[tasks]
22+
23+
[dependencies]
24+
semibin = ">=2.1.0,<3"
25+
```
26+
27+
Then, run `pixi install` in the same directory as the `pixi.toml` file to download and install SemiBin2.
28+
29+
30+
### With GPU support
31+
32+
If you want to use SemiBin with GPU, you need to install Pytorch with GPU support as well. Starting with the example above, you need to add `pytorch-gpu` to the `dependencies` section and `cuda` to the `system-requirements` section.
33+
34+
```toml
35+
[project]
36+
authors = ["Luis Pedro Coelho <luis@luispedro.org>"]
37+
channels = ["conda-forge", "bioconda"]
38+
name = "semibin_install"
39+
platforms = ["linux-64"]
40+
version = "0.1.0"
41+
42+
[tasks]
43+
44+
[dependencies]
45+
semibin = ">=2.1.0,<3"
46+
pytorch-gpu = "*"
47+
48+
[system-requirements]
49+
cuda = "12.0"
50+
```
451

552
## Install from bioconda
653

7-
### Simple Mode
854

9-
The simplest way to install is to use [conda](https://conda.io/).
55+
Pixi is now the recommended way to install SemiBin. However, if you prefer to use conda, you can install SemiBin with it
56+
57+
### Simple Mode
1058

1159
```bash
1260
conda create -n SemiBin
@@ -28,17 +76,14 @@ conda install pytorch torchvision torchaudio cudatoolkit=10.2 -c pytorch-lts
2876
## Install from source
2977

3078
You will need the following dependencies:
31-
- [MMseqs2](https://github.com/soedinglab/MMseqs2)
3279
- [Bedtools](http://bedtools.readthedocs.org/]), [Hmmer](http://hmmer.org/)
3380
- [Prodigal](https://github.com/hyattpd/Prodigal)
34-
- (optionally) [Fraggenescan](https://sourceforge.net/projects/fraggenescan/)
3581

3682

3783
You can obtain them from conda with the following commands
3884

3985
```bash
40-
conda install -c conda-forge -c bioconda mmseqs2=13.45111
41-
conda install -c bioconda bedtools hmmer fraggenescan samtools
86+
conda install -c bioconda bedtools hmmer samtools
4287
```
4388

4489
Then, installing should be a simple matter of running:

0 commit comments

Comments
 (0)