datapackage.json

{
  "name": "first-drop",
  "title": "Initial PCB-based Experimental Device Sample Recordings",
  "id": "c40f94d8-46bb-4f93-8ed6-5f5e28c8132b",
  "description": "Pilot dataset from an integrated experimental device used for multi-channel process monitoring at miniature scales. Includes synchronized telemetry from laboratory instruments, connection mapping, quality-control annotations, image metadata, and run logs. The run represents a multi-day automated process trial using standard test materials.",
  "keywords": ["telemetry", "multichannel", "timeseries"],
  "licenses": [
    {
      "name": "CC-BY-4.0",
      "path": "https://creativecommons.org/licenses/by/4.0/"
    }
  ],
  "contributors": [
    {
      "title": "Iku Bio",
      "role": "maintainer"
    }
  ],
  "created": "2025-09-25T00:00:00Z",
  "modified": "2025-10-03T00:00:00Z",
  "version": "0.1.0",
  "language": "en",
  "sources": [
    {
      "title": "Instrument telemetry (DMM, LCR meter, oscilloscope, pump controller)",
      "path": "dataset-001/runs/run-0001/timeseries/"
    },
    {
      "title": "Experimental protocols and SOPs",
      "path": "dataset-001/protocols/"
    }
  ],
  "resources": [
    {
      "name": "connection_map",
      "path": "devices/connection_map.csv",
      "format": "csv",
      "mediatype": "text/csv",
      "description": "Mapping between devices, sensors, and instruments.",
      "schema": {
        "fields": [
          {"name": "connection_tag", "type": "string", "description": "Short identifier for connection"},
          {"name": "connection_uuid", "type": "string", "description": "UUID for connection", "constraints": {"required": false}},
          {"name": "device_tag", "type": "string", "description": "Device tag"},
          {"name": "sensor_tag", "type": "string", "description": "Sensor tag", "constraints": {"required": false}},
          {"name": "instrument_tag", "type": "string", "description": "Instrument tag"},
          {"name": "connection_type", "type": "string", "description": "Type of linkage or channel between modules."},
          {"name": "unit", "type": "string", "description": "Unit of measurement", "constraints": {"required": false}},
          {"name": "notes", "type": "string", "description": "Free-text notes", "constraints": {"required": false}}
        ]
      }
    },
    {
      "name": "qc_flags",
      "path": "runs/run-0001/qc_flags.csv",
      "format": "csv",
      "mediatype": "text/csv",
      "description": "Quality control annotations (operator notes, instrument events, environment changes).",
      "schema": {
        "fields": [
          {"name": "flag_tag", "type": "string"},
          {"name": "flag_uuid", "type": "string", "constraints": {"required": false}},
          {"name": "time_ns", "type": "integer", "description": "Epoch nanoseconds", "constraints": {"required": false}},
          {"name": "time_utc_iso8601", "type": "datetime"},
          {"name": "flag_type", "type": "string"},
          {"name": "severity", "type": "string", "constraints": {"enum": ["INFO","WARNING","CRITICAL"]}},
          {"name": "sensor_tag", "type": "string", "constraints": {"required": false}},
          {"name": "instrument_tag", "type": "string", "constraints": {"required": false}},
          {"name": "value_state", "type": "string", "constraints": {"enum": ["VALID","INVALID","MISSING","NA"]}},
          {"name": "details", "type": "string"},
          {"name": "reviewer", "type": "string"}
        ]
      }
    },
    {
      "name": "images",
      "path": "runs/run-0001/images.csv",
      "format": "csv",
      "mediatype": "text/csv",
      "description": "Image metadata linked to run and sample. Images are representative and do not depict device architecture.",
      "schema": {
        "fields": [
          {"name": "image_uuid", "type": "string", "constraints": {"required": false}},
          {"name": "file_name", "type": "string"},
          {"name": "file_hash", "type": "string", "description": "Hexadecimal SHA-256 digest of file contents", "constraints": {"required": false}},
          {"name": "time_ns", "type": "integer", "constraints": {"required": false}},
          {"name": "time_utc_iso8601", "type": "datetime"},
          {"name": "run_tag", "type": "string"},
          {"name": "sample_tag", "type": "string"},
          {"name": "instrument_tag", "type": "string"},
          {"name": "notes", "type": "string", "constraints": {"required": false}}
        ]
      }
    },
    {
      "name": "dmm_01",
      "path": "runs/run-0001/timeseries/dmm-01.csv",
      "format": "csv",
      "mediatype": "text/csv",
      "description": "Voltage or resistance readings from standard laboratory instrumentation.",
      "schema": {
        "fields": [
          {"name": "time_ns", "type": "integer"},
          {"name": "recorder_time_s", "type": "number"},
          {"name": "instrument_tag", "type": "string"},
          {"name": "sensor_tag", "type": "string"},
          {"name": "func", "type": "string"},
          {"name": "value", "type": "number"},
          {"name": "value_state", "type": "string", "constraints": {"enum": ["VALID","INVALID","MISSING","NA"]}},
          {"name": "unit", "type": "string"}
        ]
      }
    },
    {
      "name": "oscope_01",
      "path": "runs/run-0001/timeseries/oscope-01.csv",
      "format": "csv",
      "mediatype": "text/csv",
      "description": "High-frequency analog measurement channel recorded via oscilloscope.",
      "schema": {
        "fields": [
          {"name": "time_ns", "type": "integer"},
          {"name": "recorder_time_s", "type": "number"},
          {"name": "instrument_tag", "type": "string"},
          {"name": "device_tag", "type": "string"},
          {"name": "channel", "type": "integer"},
          {"name": "meas", "type": "string"},
          {"name": "value", "type": "number"},
          {"name": "value_state", "type": "string", "constraints": {"enum": ["VALID","INVALID","MISSING","NA"]}},
          {"name": "unit", "type": "string"}
        ]
      }
    },
    {
      "name": "lcr_meter_01",
      "path": "runs/run-0001/timeseries/lcr-meter-01.csv",
      "format": "csv",
      "mediatype": "text/csv",
      "description": "Frequency-swept instrument data captured from an experimental device.",
      "schema": {
        "fields": [
          {"name": "time_ns", "type": "integer"},
          {"name": "recorder_time_s", "type": "number"},
          {"name": "instrument_tag", "type": "string"},
          {"name": "sensor_tag", "type": "string"},
          {"name": "frequency_hz", "type": "string"},
          {"name": "primary", "type": "number"},
          {"name": "secondary", "type": "number"},
          {"name": "comp", "type": "integer", "constraints": {"required": false}},
          {"name": "value_state", "type": "string", "constraints": {"enum": ["VALID","INVALID","MISSING","NA"]}},
          {"name": "unit", "type": "string", "constraints": {"required": false}}
        ]
      }
    },
    {
      "name": "pump_controller_01",
      "path": "runs/run-0001/timeseries/pump-controller-01.csv",
      "format": "csv",
      "mediatype": "text/csv",
      "description": "Actuator control telemetry (setpoint and feedback).",
      "schema": {
        "fields": [
          {"name": "time_ns", "type": "integer"},
          {"name": "recorder_time_s", "type": "number"},
          {"name": "instrument_tag", "type": "string"},
          {"name": "device_tag", "type": "string"},
          {"name": "parameter", "type": "string"},
          {"name": "value", "type": "number"},
          {"name": "value_state", "type": "string", "constraints": {"enum": ["VALID","INVALID","MISSING","NA"]}},
          {"name": "unit", "type": "string"}
        ]
      }
    }
  ]
}