rads.paths module

All (Py)RADS specific paths.

rads.paths.rads_xml(dataroot: Union[str, os.PathLike]) → pathlib.Path

Path to the main RADS configuration file.

This will be at <dataroot>/conf/rads.xml.

Parameters

dataroot – Path to the RADS data root.

Returns

Path to the main RADS configuration file.

rads.paths.site_config() → pathlib.Path

Path to the PyRADS site/system configuration file.

Operating System	Path
Mac OS X	/Library/Application Support/pyrads/settings.xml
Unix	/etc/pyrads
Windows	C:ProgramDatapyradssettings.xml

Returns

Path to the PyRADS site/system wide configuration file.

rads.paths.user_xml() → pathlib.Path

Path to the user local RADS configuration file.

This will be at ~/.rads/rads.xml regardless of operating system.

Returns

Path to the user local RADS configuration file.

rads.paths.user_config() → pathlib.Path

Path to the PyRADS user local configuration file.

Operating System	Path
Mac OS X	~/Library/Preferences/pyrads/settings.xml
Unix	~/.config/pyrads/settings.xml
Windows	C:Users<username>AppDataLocalpyradssettings.xml

Returns

Path to the PyRADS user local configuration file.

rads.paths.local_xml() → pathlib.Path

Path to the local RADS configuration file.

This will be rads.xml in the current directory.

Returns

Path to the local RADS configuration file.

rads.paths.local_config() → pathlib.Path

Path to the local RADS configuration file.

This will be pyrads.xml in the current directory.

Returns

Path to the local RADS configuration file.