1
1
(sec-installation)=
2
2
# Installation
3
3
4
+ `` bio2zarr `` can either be installed from bioconda or PyPI.
4
5
6
+ By default the `` bio2zarr `` PyPI package does not come with dependencies
7
+ needed to convert VCF or tskit files, so optional dependencies
8
+ need to be specified:
5
9
``` bash
6
- python3 -m pip install bio2zarr
10
+ python3 -m pip install bio2zarr # Base package with only plink support
11
+ python3 -m pip install bio2zarr[vcf] # Install with VCF support
12
+ python3 -m pip install bio2zarr[tskit] # Install with tskit support
13
+ python3 -m pip install bio2zarr[all] # Install with all optional dependencies
7
14
```
8
15
9
- This will install the programs `` vcf2zarr `` and `` vcf_partition ``
10
- into your local Python path. You may need to update your $PATH to call the
16
+ For bioconda users, a package with all optional dependencies already included
17
+ is available in the [ bioconda channel] ( https://anaconda.org/bioconda/bio2zarr ) :
18
+ ``` bash
19
+ conda install -c bioconda bio2zarr
20
+ ```
21
+
22
+ This will install the programs `` vcf2zarr `` , `` vcf_partition `` , `` tskit2zarr ``
23
+ and `` plink2zarr `` into your local Python path. You may need to update your $PATH to call the
11
24
executables directly.
12
25
13
- Alternatively, calling
26
+ Alternatively, calling for example:
14
27
``` bash
15
28
python3 -m bio2zarr vcf2zarr < args>
16
29
```
@@ -21,16 +34,14 @@ vcf2zarr <args>
21
34
```
22
35
and will always work.
23
36
24
- :::{note}
25
- The `` python3 -m bio2zarr vcf2zarr `` form may be replaced with
26
- `` python3 -m bio2zarr.vcf2zarr `` in the near future.
27
- See GitHub issue [ 203] ( https://github.com/sgkit-dev/bio2zarr/issues/203 ) .
28
- :::
29
-
30
37
:::{warning}
31
- Windows is not currently supported. Please comment on
38
+ Windows support is preliminary, partial and needs to be fully documented.
39
+ We recommend trying the bioconda packages in the first instance, and if
40
+ this doesn't work try using Windows Subsystem for Linux (WSL).
41
+ Please comment on
32
42
[ this issue] ( https://github.com/sgkit-dev/bio2zarr/issues/174 ) if you would
33
- like to see Windows support for bio2zarr.
43
+ like to see improved Windows support for bio2zarr, or would like to
44
+ help out with this.
34
45
:::
35
46
36
47
@@ -40,9 +51,11 @@ To enable shell completion for a particular session in Bash do:
40
51
41
52
``` bash
42
53
eval " $( _VCF2ZARR_COMPLETE=bash_source vcf2zarr) "
54
+ eval " $( _TSKIT2ZARR_COMPLETE=bash_source tskit2zarr) "
55
+ eval " $( _PLINK2ZARR_COMPLETE=bash_source plink2zarr) "
43
56
```
44
57
45
- If you add this to your `` .bashrc `` vcf2zarr shell completion should available
58
+ If you add this to your `` .bashrc `` shell completion should available
46
59
in all new shell sessions.
47
60
48
61
See the [ Click documentation] ( https://click.palletsprojects.com/en/8.1.x/shell-completion/#enabling-completion )
0 commit comments