sensortoolkit.lib_utils._sensor_subfolders

This module contains a method create_directories() for constructing the folder structure utilized by sensortoolkit for storing datasets and organizing related files. This folder structure is located at the path to a directory the user wishes to store evaluation-related content in. This path is referred to as the project path. Sensor and reference datasets as well as supplementary statistics are stored in a /data folder. Figures created by the library are stored in a /figures folder. Testing reports are saved within a /reports folder.

Below is the directory structure created by running the create_directories() method for an example sensor example_sensor within the project path .../my_evalution

my_evaluation                       <-- Top level directory. Set as ``work_path``.
├───data                            <-- Sensor and reference data, statistics, setup configuration files, etc.
│   ├───eval_stats
│   │   └───example_sensor
│   ├───reference_data              <-- Subdirectories organized by reference data source.
│   │   ├───airnow
│   │   │   ├───processed
│   │   │   └───raw
│   │   ├───airnowtech
│   │   │   ├───processed
│   │   │   └───raw
│   │   └───aqs
│   │       ├───processed
│   │       └───raw
│   └───sensor_data                 <-- Subdirectories organized by sensor type.
│       └───example_sensor
│           ├───processed_data
│           └───raw_data
├───figures                         <-- Figures. Subdirectories organized by sensor type.
│   └───example_sensor
└───reports

@Author:
Samuel Frederick, NSSC Contractor (ORAU)
U.S. EPA / ORD / CEMM / AMCD / SFSB
Created:

Wed May 19 16:08:15 2021

Last Updated:

Wed Jul 14 08:49:37 2021

Functions

create_sensor_directories

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