Skip to content

Commit 7dbbaad

Browse files
Various documentation updates
1 parent 77a7579 commit 7dbbaad

File tree

5 files changed

+43
-2
lines changed

5 files changed

+43
-2
lines changed

docs/installation.md

Lines changed: 7 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,4 @@
1+
(sec-installation)=
12
# Installation
23

34

@@ -20,6 +21,12 @@ vcf2zarr <args>
2021
```
2122
and will always work.
2223

24+
:::{note}
25+
The ``python3 -m bio2zarr vcf2zarr`` for 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+
2330

2431
:::{warning}
2532
Windows is not currently supported. Please comment on

docs/intro.md

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -23,3 +23,5 @@ support for other formats (or an interested in helping with implementing),
2323
please open an [issue on Github](https://github.com/sgkit-dev/bio2zarr/issues)
2424
to discuss!
2525

26+
The package is currently focused on command line interfaces, but a
27+
Python API is also planned.

docs/vcf2zarr/cli_ref.md

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,4 @@
1+
(sec-vcf2zarr-cli-ref)=
12
# CLI Reference
23

34
% A note on cross references... There's some weird long-standing problem with
@@ -57,6 +58,7 @@
5758
## Encode
5859

5960
```{eval-rst}
61+
.. _cmd-vcf2zarr-encode:
6062
.. click:: bio2zarr.cli:encode
6163
:prog: vcf2zarr encode
6264
:nested: full

docs/vcf2zarr/overview.md

Lines changed: 31 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,10 +1,39 @@
11
(sec-vcf2zarr)=
22
# vcf2zarr
33

4-
54
Convert VCF data to the
65
[VCF Zarr specification](https://github.com/sgkit-dev/vcf-zarr-spec/)
7-
reliably, in parallel.
6+
reliably, in parallel or distributed over a cluster.
7+
8+
See the {ref}`sec-vcf2zarr-tutorial` for a step-by-step introduction
9+
and the {ref}`sec-vcf2zarr-cli-ref` detailed documentation on
10+
command line options.
11+
12+
13+
## Quickstart
14+
15+
First {ref}`install bio2zarr<sec-installation>`
16+
17+
18+
## How does it work?
19+
The conversion of VCF data to Zarr is a two-step process:
20+
21+
1. Convert ({ref}`explode<cmd-vcf2zarr-explode>`) VCF file(s) to
22+
Intermediate Columnar Format (ICF)
23+
2. Convert ({ref}`encode<cmd-vcf2zarr-encode>`) ICF to Zarr
24+
25+
This two-step process allows `vcf2zarr` to determine the correct
26+
dimension of Zarr arrays corresponding to each VCF field, and
27+
to keep memory usage tightly bounded while writing the arrays.
28+
29+
:::{important}
30+
The intermediate columnar format is not intended for any use
31+
other than a temporary storage while converting VCF to Zarr.
32+
The format may change between versions of `bio2zarr`.
33+
:::
34+
35+
36+
## Common options
837

938
```
1039
$ vcf2zarr convert <VCF1> <VCF2> <zarr>

docs/vcf2zarr/tutorial.md

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -9,6 +9,7 @@ kernelspec:
99
language: bash
1010
name: bash
1111
---
12+
(sec-vcf2zarr-tutorial)=
1213
# Tutorial
1314

1415
This is a step-by-step tutorial showing you how to convert your

0 commit comments

Comments
 (0)