Skip to content

Commit

Permalink
Merge pull request #240 from melissalinkert/clarify-memo-saving
Browse files Browse the repository at this point in the history
Clarify that .*.bfmemo files won't always be created
  • Loading branch information
sbesson authored Jan 24, 2024
2 parents ae9baf4 + 663a466 commit aa4e0e6
Showing 1 changed file with 4 additions and 2 deletions.
6 changes: 4 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -306,15 +306,17 @@ relative performance.
Metadata caching
================

During conversion, a temporary `.*.bfmemo` file will be created. By default, this file is in the same directory as the input data
During conversion, a temporary `.*.bfmemo` file may be created. By default, this file is in the same directory as the input data
and will be removed after the conversion finishes. The location of the `.*.bfmemo` file can be configured using the `--memo-directory` option:

bioformats2raw /path/to/file.mrxs /path/to/zarr-pyramid --memo-directory /tmp/

This is particularly helpful if you do not have write permissions in the input data directory.

As of version 0.5.0, `.*.bfmemo` files are deleted at the end of conversion by default. We do not recommend keeping these files for normal
conversions, but if they are needed for troubleshooting then the `--keep-memo-files` option can be used.
conversions, but if they are needed for troubleshooting then the `--keep-memo-files` option can be used. Note that if a memo file did not
need to be created, `--keep-memo-files` will still result in no `.*.bfmemo` files at the end of conversion. This is particularly common
for small datasets that can be read very quickly.

Downsampling type
=================
Expand Down

0 comments on commit aa4e0e6

Please sign in to comment.