diff --git a/README.md b/README.md index 3d8e063e0fc430911dc90da415757b467ab0ef9f..ab562a7608d87942e550e8544be1c1e66cff0507 100644 --- a/README.md +++ b/README.md @@ -38,7 +38,7 @@ The default HDF5 measurement file has the following structure, | ``` -If the `write_all` option is set to `True`, the HDF5 measurement file also contains intermediary simulated quantities. Refer to [`Instrument.write()`](https://gitlab.in2p3.fr/lisa-simulation/instrument/-/blob/master/lisainstrument/instrument.py) for more information. +If the `keep_all` option is set to `True`, the HDF5 measurement file also contains intermediary simulated quantities. Refer to [`Instrument.write()`](https://gitlab.in2p3.fr/lisa-simulation/instrument/-/blob/master/lisainstrument/instrument.py) for more information. Metadata are saved as attributes of the measurement file. @@ -87,10 +87,10 @@ instrument = Instrument() instrument.write() ``` -You can specify a path to the measurement file, and set `write_all` to `True` to save intermediary simulated quantities, +You can specify a path to the measurement file, and set `keep_all` to `True` to save intermediary simulated quantities, ```python -instrument.write('my-file.h5', write_all=True) +instrument.write('my-file.h5', keep_all=True) ``` ### Plot measurements