sensortoolkit.lib_utils._sensor_subfolders.create_sensor_directories

create_sensor_directories(name=None, param=None, path=None)[source]

Construct the sensor directory file structure required for conducting analysis with the SensorEvaluation library.

Parameters
  • name (str, optional) – The name assigned to the sensor. Recommend using the sensor’s make and model, separated by underscores (‘_’). Defaults to None.

  • param (str or list of strings, optional) – The parameter(s) measured by the sensor that the user wishes to evaluate. Defaults to None.

  • path (str, optional) – The full path to the work directory where the user intends to store datasets, figures, and reports. Defaults to None.

Raises

TypeError – Raise if type for param is neither list or string.

Returns

None.