Skip to content

Commit d49d970

Browse files
authored
Promote header levels in tutorial.md (#228)
The table of contents seems weird when the main `## Tutorial` is an h2. Moreover, it messes up the navbar on the side because Documenter.jl doesn't include h3 elements in the sidebar
1 parent 43a180f commit d49d970

File tree

1 file changed

+7
-7
lines changed

1 file changed

+7
-7
lines changed

docs/src/tutorial.md

Lines changed: 7 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -5,11 +5,11 @@ DocTestSetup = quote
55
end
66
```
77

8-
## Tutorial
8+
# Tutorial
99

1010
Zarr provides classes and functions for working with N-dimensional arrays that behave like Julia arrays but whose data is divided into chunks and each chunk is compressed. If you are already familiar with HDF5 then Zarr arrays provide similar functionality, but with some additional flexibility. This tutorial is an attempt to recreate this [Python Zarr tutorial](https://zarr.readthedocs.io/en/stable/tutorial.html) as closely as possible and some of the explanation text is just copied and modified from this source.
1111

12-
### Creating an in-memory array
12+
## Creating an in-memory array
1313

1414
Zarr has several functions for creating arrays. For example:
1515

@@ -24,7 +24,7 @@ The code above creates a 2-dimensional array of 32-bit integers with 10000 rows
2424

2525
Other Array creation routines are [`zcreate`, `zones` and `zfill`].
2626

27-
### Reading and Writing data
27+
## Reading and Writing data
2828

2929
Zarr arrays support a similar interface to Julia arrays for reading and writing data, although they don't implement the all indexing methods of an `AbstractArray` yet. For example, the entire array can be filled with a scalar value:
3030

@@ -83,7 +83,7 @@ julia> z[1:5,1:10]
8383
5 42 42 42 42 42 42 42 42 42
8484
```
8585

86-
### Persistent arrays
86+
## Persistent arrays
8787

8888
In the examples above, compressed data for each chunk of the array was stored in main memory. Zarr arrays can also be stored on a file system, enabling persistence of data between sessions. For example:
8989

@@ -123,7 +123,7 @@ true
123123

124124
*A Julia-equivalent for zarr.load and zarr.save is still missing...*
125125

126-
### Resizing and appending
126+
## Resizing and appending
127127

128128
A Zarr array can be resized, which means that any of its dimensions can be increased or decreased in length. For example:
129129

@@ -163,7 +163,7 @@ julia> size(z)
163163
(2000, 20000)
164164
```
165165

166-
### Compressors
166+
## Compressors
167167

168168
A number of different compressors can be used with Zarr. In this Julia package we currently support only Blosc compression, but more compression methods will be supported in the future. Different compressors can be provided via the compressor keyword argument accepted by all array creation functions. For example:
169169

@@ -216,7 +216,7 @@ julia> storageratio(z)
216216
1.0
217217
```
218218

219-
### Ragged Arrays
219+
## Ragged Arrays
220220

221221
If you need to store an array of arrays, where each member array can be of any length and stores the same data type (a.k.a. a ragged array), `VLenArray` filter will be used, e.g.:
222222

0 commit comments

Comments
 (0)