Files
idear-template/campaignDescriptor.yaml

67 lines
2.6 KiB
YAML

# ------------------------------------------------------------------------------
# Configuration for FAIR Data Integration Pipeline
# ------------------------------------------------------------------------------
# Can be a local or network path. Examples:
# - Local: '../data/data_folder/' # All paths must be relative to folder ../data/
# - Network: /mnt/network_drive/data_folder or equivalently ${NETWORK_MOUNT}/data_folder
input_file_directory: '/mnt/network_mount/Data'
# OUTPUT DATA DIRECTORY
# Always relative to notebook location. If run from `notebooks/`,
# output will be saved in `../data/`.
# Do not modify unless you're running from the project root.
output_file_directory: '../data/'
# ------------------------------------------------------------------------------
# Project Metadata
# ------------------------------------------------------------------------------
project: 'Insert project title here'
contact: 'Your Name or Team'
group_id: '0000' # Optional internal group or project ID
# Type of experiment (e.g., campaign, flow_tube_study, smog_chamber, lab_study)
experiment: 'experiment_type'
# Dataset coverage range (optional but recommended)
dataset_startdate: 'YYYY-MM-DD'
dataset_enddate: 'YYYY-MM-DD'
# Data processing level (typically '0', '1', or '2'; follows ACTRIS or custom standards)
actris_level: '0'
# ------------------------------------------------------------------------------
# Output File Naming Convention (Optional)
# ------------------------------------------------------------------------------
# Year of observation
year: 'YYYY'
# Format string used to define output filenames.
# You may use any field from this config as a part, comma-separated.
# Example: 'experiment, year' → experiment_year.h5
filename_format: 'experiment, year'
# ------------------------------------------------------------------------------
# Instrument Data Source
# ------------------------------------------------------------------------------
# Relative subdirectories inside the input directory that contain instrument data.
# Use one or more folder paths as needed.
instrument_datafolder:
- 'instFolder1/subfolder/'
- 'instFolder2'
# ------------------------------------------------------------------------------
# Data Integration Options
# ------------------------------------------------------------------------------
# Integration mode: 'collection' or 'single_experiment'.
integration_mode: 'collection'
# Optional: list of timestamps marking experimental phases or steps.
# Format each entry as: 'YYYY-MM-DD HH:MM:SS'
datetime_steps: []