Skip to content

Commit

Permalink
Add documentation.
Browse files Browse the repository at this point in the history
  • Loading branch information
atrabattoni committed Sep 4, 2024
1 parent 3eb57fb commit 91ec8e0
Showing 1 changed file with 13 additions and 8 deletions.
21 changes: 13 additions & 8 deletions docs/user-guide/data-formats.md
Original file line number Diff line number Diff line change
Expand Up @@ -20,14 +20,19 @@ os.chdir("../_data")

## Implemented file formats

The formats that are currently implemented are: ASN, FEBUS, OPTASENSE and SINTELA. To read them you have to specifiy which one you want in the `engine` argument in {py:func}`xdas.open_dataarray` for a single file or {py:func}`xdas.open_mfdataarray` for multiple files:

| DAS constructor | `engine` argument |
|:-----------------:|:-----------------:|
| ASN | `"asn"` |
| FEBUS | `"febus"` |
| OPTASENSE | `"optasense"` |
| SINTELA | `"sintela"` |
Here below the list of formats that are currently implemented. All HDF5 based formats actually support virtualization, meaning that format that does not support it will load data in memory when reading files. To read them you have to specifiy which one you want in the `engine` argument in {py:func}`xdas.open_dataarray` for a single file or {py:func}`xdas.open_mfdataarray` for multiple files:

| DAS constructor | `engine` argument | Virtualization |
|:-----------------:|:-----------------:|:-:|
| ASN | `"asn"` | ✅︎ |
| FEBUS | `"febus"` | ✅︎ |
| OPTASENSE | `"optasense"` | ✅︎ |
| SILIXA | `"silixa"` ||
| SINTELA | `"sintela"` | ✅︎ |

```{warning}
File formats that do not support virtualization will be loaded in memory. We are working on a solution for non-HDF5 based file formats.
```

## Extending *xdas* with your file format

Expand Down

0 comments on commit 91ec8e0

Please sign in to comment.