Skip to content

Commit e96fc93

Browse files
Update explanation_performance.md
1 parent 0e00af3 commit e96fc93

1 file changed

Lines changed: 5 additions & 5 deletions

File tree

docs/user_guide/examples/explanation_performance.md

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -6,7 +6,7 @@ In this tutorial, we will show how to squeeze performance in Parcels by using a
66

77
## Option 1: explicitly load the full FieldSet into memory
88

9-
**Works well for: small Datasets (less than a few GB)**
9+
**Best for: small Datasets (less than a few GB)**
1010

1111
For relatively small Datasets (less than a few GB), it is possible to load the entire FieldSet into memory. This can be done by calling the `load()` method on the `xarray.Dataset` object:
1212

@@ -24,7 +24,7 @@ This will make Parcels use `numpy` functions in the interpolation routines, whic
2424

2525
## Option 2: use cached zarr files
2626

27-
**Works well for: large Datasets (more than a few GB) and particles distributed over a small part of the domain**
27+
**Best for: large Datasets (more than a few GB) and particles distributed over a small part of the domain**
2828

2929
If your Dataset is too large to fit into memory, but your particles are only distributed over a small part of the domain, it could be efficient to use cached zarr files. This can be done by using the (experimental) `zarr.CacheStore` in combination with the `parcels.open_raw_zarr()` function. This will make Parcels only load the chunks that are needed for the particles, and cache these chunks in memory for future use.
3030

@@ -51,7 +51,7 @@ In our performance testing, we have found that using zarr files saved without an
5151

5252
## Option 3: use `fieldset.to_windowed_arrays()`
5353

54-
**Works well for: large Datasets (more than a few GB) and particles distributed over the entire domain**
54+
**Best for: large Datasets (more than a few GB) and particles distributed over the entire domain**
5555

5656
If your Dataset is so large that it doesn't fit into memory, you can use the `fieldset.to_windowed_arrays()` method to make Parcels only hold two timeslices in memory. Note that this only works if the two timeslices still fit into memory.
5757

@@ -70,7 +70,7 @@ fieldset.to_windowed_arrays()
7070

7171
## Option 4: use Dask
7272

73-
**Works well for: large Datasets (more than a few GB) and small ParticleSets (less than a few hundred particles)**
73+
**Best for: large Datasets (more than a few GB) and small ParticleSets (less than a few hundred particles)**
7474

7575
If your Dataset is so large that it doesn't fit into memory, and you have very few particles, you can use Dask to perform the interpolation operations. In this case, you don't have to do any special setup, as Parcels will automatically use Dask if the `xarray.Dataset` is a Dask array.
7676

@@ -81,5 +81,5 @@ If your Dataset is so large that it doesn't fit into memory, and you have very f
8181
| Works out-of-the-box | Only performs well for very small ParticleSets |
8282

8383
```{note}
84-
The long-term plan for Parcles development is to make this Option 4 work well for all cases. However, this will require significant work on Dask indexing.
84+
The long-term plan for Parcels development is to make this Option 4 work well for all cases. However, this will require significant work on Dask indexing.
8585
```

0 commit comments

Comments
 (0)