Skip to content

Commit

Permalink
Add note about reading particle data to readme
Browse files Browse the repository at this point in the history
  • Loading branch information
ZedThree committed Aug 19, 2024
1 parent aeddba8 commit ae4abee
Showing 1 changed file with 10 additions and 0 deletions.
10 changes: 10 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -62,3 +62,13 @@ print(ds)
# Indexes: (9)
# Attributes: (22)
```

### Reading particle data

By default, particle data isn't kept. Pass `keep_particles=True` as a
keyword argument to `open_dataset` (for single files) or
`open_mfdataset` (for multiple files):

```python
df = xr.open_dataset("0010.sdf", keep_particles=True)
```

0 comments on commit ae4abee

Please sign in to comment.