Skip to content

Commit

Permalink
Add some doc.
Browse files Browse the repository at this point in the history
  • Loading branch information
atrabattoni committed Sep 18, 2024
1 parent 3941c76 commit 76cf8e5
Showing 1 changed file with 5 additions and 0 deletions.
5 changes: 5 additions & 0 deletions docs/user-guide/data-formats.md
Original file line number Diff line number Diff line change
Expand Up @@ -30,6 +30,11 @@ The formats that are currently implemented are: ASN, FEBUS, OPTASENSE, SINTELA a
| SINTELA | `"sintela"` |
| TERRA15 | `"terra15"` |

```{warning}
Due to poor documentation of the various version of the Febus format, it is recommended to manually provide the required trimming and the position of the timestamps within each block. For example to trim 100 samples on both side of each block and to set the timestamp location at the center of the block for a block of 2000 samples:
`xdas.open_dataarray("path.h5", engine="febus", overlaps=(100, 100), offset=1000)`
```

## Extending *xdas* with your file format

*xdas* insists on its extensibility, the power is in the hands of the users. Extending *xdas* usually consists of writing few-line-of-code-long functions. The process consists in dealing with the two main aspects of a {py:class}`xarray.DataArray`: unpacking the data and coordinates objects, eventually processing them and packing them back into a Database object.
Expand Down

0 comments on commit 76cf8e5

Please sign in to comment.