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
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
Copy file name to clipboardExpand all lines: docs/src/tutorial.md
+7-7Lines changed: 7 additions & 7 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -5,11 +5,11 @@ DocTestSetup = quote
5
5
end
6
6
```
7
7
8
-
##Tutorial
8
+
# Tutorial
9
9
10
10
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.
11
11
12
-
###Creating an in-memory array
12
+
## Creating an in-memory array
13
13
14
14
Zarr has several functions for creating arrays. For example:
15
15
@@ -24,7 +24,7 @@ The code above creates a 2-dimensional array of 32-bit integers with 10000 rows
24
24
25
25
Other Array creation routines are [`zcreate`, `zones` and `zfill`].
26
26
27
-
###Reading and Writing data
27
+
## Reading and Writing data
28
28
29
29
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:
30
30
@@ -83,7 +83,7 @@ julia> z[1:5,1:10]
83
83
5 42 42 42 42 42 42 42 42 42
84
84
```
85
85
86
-
###Persistent arrays
86
+
## Persistent arrays
87
87
88
88
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:
89
89
@@ -123,7 +123,7 @@ true
123
123
124
124
*A Julia-equivalent for zarr.load and zarr.save is still missing...*
125
125
126
-
###Resizing and appending
126
+
## Resizing and appending
127
127
128
128
A Zarr array can be resized, which means that any of its dimensions can be increased or decreased in length. For example:
129
129
@@ -163,7 +163,7 @@ julia> size(z)
163
163
(2000, 20000)
164
164
```
165
165
166
-
###Compressors
166
+
## Compressors
167
167
168
168
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:
169
169
@@ -216,7 +216,7 @@ julia> storageratio(z)
216
216
1.0
217
217
```
218
218
219
-
###Ragged Arrays
219
+
## Ragged Arrays
220
220
221
221
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.:
0 commit comments