Enhance tutorial by adding Prerequisites, Understanding the example code, What is an N-dimensional array?

[DON-BRAN]

Going through the Zarr tutorial, I was thinking it will be nice to have a

• Prerequisites section: Which tells the user the basic skills necessary for using Zarr, the dependencies needed to use.
• Understanding the example code: Which contains guidelines on how to read the code snippets in the examples
• What is an N-dimensional array: Which contains definitions and samples of N-dimensional array

[sanketverma1704]

Hi @DON-BRAN.

Thanks for creating the issue. May I please know a bit more elaboration on the 1st and 2nd points?
Also, would you like to work on this?

[DON-BRAN]

Hi @DON-BRAN.

Thanks for creating the issue. May I please know a bit more elaboration on the 1st and 2nd points? Also, would you like to work on this?

Hi @MSanKeys963. Yes I would like to work on this 🙂

An example of the Prerequisites section would be

• You’ll need to know a bit of Python
• You'll need to know a bit of command line.
• You'll need to install Numpy. Zarr depends on NumPy

An example of Understanding the example code section would be
If you aren't familiar with reading code snippets in tutorials this is a basic guide to help you get started

>>> import zarr
>>> z = zarr.zeros((10000, 10000), chunks=(1000, 1000), dtype='i4')
>>> z
<zarr.core.Array (10000, 10000) int32>

If you see >>>, you’re looking at an input, or the code that you would enter.
Any line that doesn’t start with >>> is an output, or the results of running the code entered.
When running python on the command line, this is it's representation.

[Azaya89]

Hi @MSanKeys963 , Can I work on this issue?

[sanketverma1704]

Hi @DON-BRAN. Thanks for your response.

An example of the Prerequisites section would be

* You’ll need to know a bit of Python

* You'll need to know a bit of command line.

* You'll need to install Numpy. Zarr depends on NumPy

Seems good. Anything you'd like to add here @joshmoore @jakirkham ?

If you see >>>, you’re looking at an input, or the code that you would enter.
Any line that doesn’t start with >>> is an output, or the results of running the code entered.
When running python on the command line, this is it's representation.

Alright, that seems good. Please submit a PR for the same, and we can work on this. Thanks! 🙏🏻

[sanketverma1704]

Hi @Azaya89. I think @DON-BRAN is working on this. Please pick another issue to work on.

[arkdong]

@sanketverma1704 I would like to work on this issue.

When I try to compile with make html/dirhtml/singlehtml/dummy/..., it always indicate an error importlib.metadata.PackageNotFoundError: No package metadata was found for zarr, mainly cause by the line: version = get_version("zarr") in docs/conf.py

Do someone know what could be the reason for this error?

[d-v-b]

it might be that zarr is not installed in the python environment used by sphinx. we are using hatch to manage our dev environment. you should install hatch, and then run hatch run docs:build (render the docs to html) or hatch run docs:serve (serve the docs over http) to get the docs working locally.

once you get things working, maybe a "how to set up the docs" page on the docs page would be helpful!

[arkdong]

Hi @d-v-b, thank you for your reply. I've open a PR #2865 for this issue. The part related to "Prerequisites" and "Understanding the example code" was not added since I believe it is very simple and standard knowledge, and adding it is not really necessary. I did implement a "Contributing to Documentation page" but soon I realize that it already exist as a section in the page Contributing to Zarr.

If you have any other ideas that you want to put it on, or the location of the information, please let me know.

[Dronten]

can i work on this issue ?