You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: README.md
+21-11Lines changed: 21 additions & 11 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -24,7 +24,8 @@ well as their benchmarking) are described in
24
24
25
25
A tutorial of running SemiBin from scrath can be found here [SemiBin tutorial](https://github.com/BigDataBiology/SemiBin_tutorial_from_scratch).
26
26
27
-
Installation:
27
+
28
+
Installation with `conda`:
28
29
29
30
```bash
30
31
conda create -n SemiBin
@@ -59,20 +60,29 @@ Please find more options and details below and [read the docs](https://semibin.r
59
60
60
61
SemiBin runs (and is continuously tested) on Python 3.7-3.13
61
62
62
-
### Bioconda
63
+
### pixi
63
64
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:
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"
72
83
```
73
84
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.
Copy file name to clipboardExpand all lines: docs/install.md
+52-7Lines changed: 52 additions & 7 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -1,12 +1,60 @@
1
1
# Install
2
2
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
+
```
4
51
5
52
## Install from bioconda
6
53
7
-
### Simple Mode
8
54
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
0 commit comments