Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Added Group.tree method #2433

Merged
merged 5 commits into from
Nov 13, 2024
Merged

Added Group.tree method #2433

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
5 commits
Select commit Hold shift + click to select a range
f844ce6
Added Group.tree method
TomAugspurger Oct 23, 2024
1878f9f
fixup
TomAugspurger Oct 24, 2024
78828ab
Fixup
TomAugspurger Oct 24, 2024
83c26e9
Merge branch 'main' into tom/feature/tree
d-v-b Nov 7, 2024
2a159d0
remove repr_tree.ipynb
TomAugspurger Nov 8, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
14 changes: 10 additions & 4 deletions docs/tutorial.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -330,10 +330,10 @@ representation of the hierarchy, e.g.::

>>> root.tree()
/
└── foo
└── bar
├── baz (10000, 10000) int32
└── quux (10000, 10000) int32
└── foo
└── bar
├── baz (10000, 10000) int32
└── quux (10000, 10000) int32

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


.. note::

:func:`zarr.Group.tree` requires the optional `rich <https://rich.readthedocs.io/en/stable/>`_
dependency. It can be installed with the ``[tree]`` extra.

If you're using Zarr within a Jupyter notebook (requires
`ipytree <https://github.com/QuantStack/ipytree>`_), calling ``tree()`` will generate an
interactive tree representation, see the `repr_tree.ipynb notebook
Expand Down
Loading