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.

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

update readme #18

Open
wants to merge 1 commit into
base: main
Choose a base branch
from
Open
Changes from all commits
Commits
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
17 changes: 16 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,21 @@
# linkml-arrays

Support for loading and dumping N-dimensional arrays in LinkML.
This repository serves as an example repository showcasing the support for loading and dumping
N-dimensional arrays, including labeled arrays in LinkML. The examples are a work in progress,
which are used at the same time to develop the metadata model for arrays in LinkML.

## Dumpers and loaders
The repository currently includes dumpers and loaders examples
for `yaml`, `hdf5`, `numpy` and `zarr`.

## Data

<ins>Temperature dataset</ins>

The schema defining the labeled array according to the linkml array metamodel can
be found here `tests/input/temperature_schema.yaml`. The schema defines a `DataArray`
similar to an `xarray.DataArray`. The schema includes an array of values `TemperaturesInKMatrix`,
and labeled dimensions which correspond to the concept of `coordinates` in `xarray`.

# Quick reference for common commands

Expand Down
Loading