Skip to content

Commit 89e1d4f

Browse files
TomAugspurgerd-v-b
andauthored
Added Group.tree method (#2433)
* Added Group.tree method * fixup * Fixup * remove repr_tree.ipynb --------- Co-authored-by: Davis Bennett <[email protected]>
1 parent e49647b commit 89e1d4f

File tree

6 files changed

+180
-1395
lines changed

6 files changed

+180
-1395
lines changed

docs/tutorial.rst

Lines changed: 10 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -330,10 +330,10 @@ representation of the hierarchy, e.g.::
330330

331331
>>> root.tree()
332332
/
333-
└── foo
334-
└── bar
335-
├── baz (10000, 10000) int32
336-
└── quux (10000, 10000) int32
333+
└── foo
334+
└── bar
335+
├── baz (10000, 10000) int32
336+
└── quux (10000, 10000) int32
337337

338338
The :func:`zarr.convenience.open` function provides a convenient way to create or
339339
re-open a group stored in a directory on the file-system, with sub-groups stored in
@@ -424,6 +424,12 @@ Groups also have the :func:`zarr.hierarchy.Group.tree` method, e.g.::
424424
├── bar (1000000,) int64
425425
└── baz (1000, 1000) float32
426426

427+
428+
.. note::
429+
430+
:func:`zarr.Group.tree` requires the optional `rich <https://rich.readthedocs.io/en/stable/>`_
431+
dependency. It can be installed with the ``[tree]`` extra.
432+
427433
If you're using Zarr within a Jupyter notebook (requires
428434
`ipytree <https://github.com/QuantStack/ipytree>`_), calling ``tree()`` will generate an
429435
interactive tree representation, see the `repr_tree.ipynb notebook

0 commit comments

Comments
 (0)