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
[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.
6
4
This repository provides an interface to read and write Zarr arrays and metadata from MATLAB®.
7
5
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)
9
17
10
18
## Status
19
+
11
20
- Supports only Zarr v2.
12
21
- Supports reading and writing of Zarr arrays from local storage and Amazon S3.
13
22
- Supports reading and writing of Zarr metadata from local storage and Amazon S3.
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).
Before proceeding, please ensure that you have a supported version of Python® 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
+
27
48
- Python - v3.10 or newer
28
49
-[tensorstore](https://github.com/google/tensorstore) - v0.1.71 or newer
29
50
-[numpy](https://github.com/numpy/numpy) - v1.26.4 or newer
30
51
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
32
53
33
-
34
-
## Installation
35
-
Before proceeding, please ensure that you have a supported version of Python installed on your machine.
36
54
Please refer to the following links to configure your system to use Python with MATLAB:
55
+
37
56
-[Configure Your System to Use Python](https://www.mathworks.com/help/matlab/matlab_external/install-supported-python-implementation.html)
38
57
-[Access Python Modules from MATLAB - Getting Started](https://www.mathworks.com/help/matlab/matlab_external/create-object-from-python-class.html)
39
58
@@ -53,27 +72,32 @@ ans =
53
72
Status: NotLoaded
54
73
ExecutionMode: OutOfProcess
55
74
```
75
+
56
76
If the value of the `Version` property is empty, then you do not have a supported version available.
57
77
58
78
Once Python is installed, install the Python packages [tensorstore](https://github.com/google/tensorstore) and [numpy](https://github.com/numpy/numpy).
59
79
60
-
## Getting Started
80
+
## Getting Started
81
+
61
82
1. Clone the github repo to your local drive.
62
83
2. Start MATLAB.
63
84
3. Add the parent cloned directory to your MATLAB path:
To view documentation of a function, type `help <function_name>`. For example,
145
+
118
146
```MATLAB
119
147
>> help zarrcreate
120
148
```
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.
122
149
150
+
or refer to the [documentation.md](doc/documentation.md) and [examples.md](doc/examples.md) files.
123
151
124
152
## License
125
-
<!--- Make sure you have a License.txt within your Repo --->
126
153
127
-
The license is available in the `License.txt` file in this GitHub repository.
0 commit comments