Skip to content

Commit 1a9f932

Browse files
committed
Updating README
1 parent 80a802d commit 1a9f932

1 file changed

Lines changed: 46 additions & 22 deletions

File tree

README.md

Lines changed: 46 additions & 22 deletions
Original file line numberDiff line numberDiff line change
@@ -1,39 +1,58 @@
1-
[![codecov](https://codecov.io/gh/mathworks/MATLAB-support-for-Zarr-files/graph/badge.svg?token=ZBLNDOLQyA)](https://codecov.io/gh/mathworks/MATLAB-support-for-Zarr-files)
2-
3-
# MATLAB Support for Zarr files
1+
# MATLAB Support for Zarr files
42

53
[Zarr®](https://zarr-specs.readthedocs.io/en/latest/specs.html) is a chunked, compressed, _N_-dimensional array storage format optimized for performance and scalability. It is widely used in scientific computing for handling large arrays efficiently.
64
This repository provides an interface to read and write Zarr arrays and metadata from MATLAB®.
75

8-
For complete documentation, refer to the `documentation.md` file, or refer to the help section of each function.
6+
For complete documentation, refer to [documentation.md](doc/documentation.md) or the help section of each function.
7+
8+
## Feedback/Requests
9+
10+
The direction and capabilities of this package depend on feedback from users. We encourage you to ask for what you need, and we look forward to hearing from you. See [CONTRIBUTING.md](CONTRIBUTING.md) for adding new features and bug fixing.
11+
12+
Create/view [issues for MATLAB Support for Zarr files](https://github.com/mathworks/MATLAB-support-for-Zarr-files/issues) here. See [Creating good issues](https://github.com/orgs/community/discussions/147722) for tips and best practices.
13+
14+
## Community Support
15+
16+
For general questions and support for MATLAB, visit [MATLAB Central](https://www.mathworks.com/matlabcentral)
917

1018
## Status
19+
1120
- Supports only Zarr v2.
1221
- Supports reading and writing of Zarr arrays from local storage and Amazon S3.
1322
- Supports reading and writing of Zarr metadata from local storage and Amazon S3.
1423

24+
[![codecov](https://codecov.io/gh/mathworks/MATLAB-support-for-Zarr-files/graph/badge.svg?token=ZBLNDOLQyA)](https://codecov.io/gh/mathworks/MATLAB-support-for-Zarr-files)
25+
1526
## Setup
27+
1628
To use this repository, clone the repo to your local folder and add it to your MATLAB using [addpath](https://www.mathworks.com/help/matlab/ref/addpath.html).
17-
For example,
29+
For example:
30+
1831
``` MATLAB
1932
>> addpath("C:\<username>\support-Zarr-in-MATLAB\")
2033
```
2134

22-
### MathWorks Products (https://www.mathworks.com)
35+
### MathWorks Products (<https://www.mathworks.com>)
2336

2437
Requires MATLAB release R2024a or newer
2538

26-
### 3rd Party Products:
39+
## Installation
40+
41+
Before proceeding, please ensure that you have a supported version of Python&reg; installed on your machine.
42+
See [MATLAB Compatibile Python Versions](https://www.mathworks.com/support/requirements/python-compatibility.html) for the Python versions compatible with different MATLAB releases.
43+
44+
### 3rd Party Products
45+
46+
The following versions are required by this package:
47+
2748
- Python - v3.10 or newer
2849
- [tensorstore](https://github.com/google/tensorstore) - v0.1.71 or newer
2950
- [numpy](https://github.com/numpy/numpy) - v1.26.4 or newer
3051

31-
See the link [here](https://www.mathworks.com/support/requirements/python-compatibility.html) for the Python versions compatible with different MATLAB releases.
52+
### Configuring Python
3253

33-
34-
## Installation
35-
Before proceeding, please ensure that you have a supported version of Python installed on your machine.
3654
Please refer to the following links to configure your system to use Python with MATLAB:
55+
3756
- [Configure Your System to Use Python](https://www.mathworks.com/help/matlab/matlab_external/install-supported-python-implementation.html)
3857
- [Access Python Modules from MATLAB - Getting Started](https://www.mathworks.com/help/matlab/matlab_external/create-object-from-python-class.html)
3958

@@ -53,27 +72,32 @@ ans =
5372
Status: NotLoaded
5473
ExecutionMode: OutOfProcess
5574
```
75+
5676
If the value of the `Version` property is empty, then you do not have a supported version available.
5777

5878
Once Python is installed, install the Python packages [tensorstore](https://github.com/google/tensorstore) and [numpy](https://github.com/numpy/numpy).
5979

60-
## Getting Started
80+
## Getting Started
81+
6182
1. Clone the github repo to your local drive.
6283
2. Start MATLAB.
6384
3. Add the parent cloned directory to your MATLAB path:
85+
6486
``` MATLAB
6587
>> addpath ("C:\<username>\support-Zarr-in-MATLAB\")
6688
```
6789

6890
## Examples
6991

7092
### Read a Zarr array
93+
7194
``` MATLAB
7295
filepath = "group1\dset1";
7396
data = zarrread(filepath);
7497
```
7598

7699
### Create and write to a Zarr array
100+
77101
``` MATLAB
78102
filepath = "myZarrfiles\singleDset";
79103
data_size = [10,10]; % shape of the Zarr array to be written
@@ -84,6 +108,7 @@ zarrwrite(filepath, data) % Write data to the Zarr array
84108
```
85109

86110
### Create a Zarr array and write data to it using zlib compression with non-default chunking
111+
87112
``` MATLAB
88113
filepath = "myZarrfiles\singleZlibDset";
89114
@@ -99,34 +124,33 @@ compress.id = "zlib";
99124
compress.level = 8;
100125
101126
% Create the Zarr array
127+
102128
zarrcreate(filepath, data_size, ChunkSize=chunk_size, DataType="single", ...
103-
Compression=compress)
104-
129+
Compression=compress)
130+
105131
% Write to the Zarr array
106132
zarrwrite(filepath, data)
107133
```
108134

109-
110135
### Read the metadata from a Zarr array
136+
111137
``` MATLAB
112138
filepath = "group1\dset1";
113139
info = zarrinfo(filepath);
114140
```
115141

116142
## Help
143+
117144
To view documentation of a function, type `help <function_name>`. For example,
145+
118146
``` MATLAB
119147
>> help zarrcreate
120148
```
121-
or refer to the [documentation.md](https://github.com/mathworks/MATLAB-support-for-Zarr-files/blob/main/doc/documentation.md) and [examples.md](https://github.com/mathworks/MATLAB-support-for-Zarr-files/blob/main/doc/examples.md) files.
122149

150+
or refer to the [documentation.md](doc/documentation.md) and [examples.md](doc/examples.md) files.
123151

124152
## License
125-
<!--- Make sure you have a License.txt within your Repo --->
126153

127-
The license is available in the `License.txt` file in this GitHub repository.
128-
129-
## Community Support
130-
[MATLAB Central](https://www.mathworks.com/matlabcentral)
154+
The license is available in the [License.txt](License.txt) file in this GitHub repository.
131155

132-
Copyright 2025 The MathWorks, Inc.
156+
Copyright 2025-2026 The MathWorks, Inc.

0 commit comments

Comments
 (0)