pyrcs.utils.cd_dat

pyrcs.utils.cd_dat(*sub_dir, dat_dir='dat', mkdir=False, **kwargs)[source]

Change directory to dat_dir/ and sub-directories within a package.

Parameters

  • sub_dir (str) – name of directory; names of directories (and/or a filename)

  • dat_dir (str) – name of a directory to store data, defaults to "dat"

  • mkdir (bool) – whether to create a directory, defaults to False

  • kwargs – optional parameters of os.makedirs, e.g. mode=0o777

Returns

a full path to a directory (or a file) under data_dir

Return type

str

Example:

>>> import os
>>> from pyrcs.utils import cd_dat

>>> path_to_dat_dir = cd_dat("line-data", dat_dir="dat", mkdir=False)
>>> print(os.path.relpath(path_to_dat_dir))
pyrcs\dat\line-data