User directories

Contents

User directories#

The h5rdmtoolbox uses a couple of local directories to store temporary files or manage cache files.

import h5rdmtoolbox as h5tbx

The UserDir variable manages the paths. The __repr__ indicates the different paths:

h5tbx.UserDir
DirManger(root, tmp, convention, layouts, repository, standard_name_tables, cache)

Examples#

Temporary files, e.g. created when empty h5tbx.File objects are created, will be put here:

h5tbx.UserDir['tmp']
PosixPath('/home/docs/.local/share/h5rdmtoolbox/2.5.2/tmp/tmp_1')

Let’s check it:

with h5tbx.File() as h5:
    filename = h5.hdf_filename
filename
PosixPath('/home/docs/.local/share/h5rdmtoolbox/2.5.2/tmp/tmp_1/tmp0.hdf')

Tokens for repositories, e.g. Zenodo, should be put here:

h5tbx.UserDir['repository']
PosixPath('/home/docs/.local/share/h5rdmtoolbox/2.5.2/repository')