Skip to content

NodeSummary Configuration

Arden Burrell edited this page Apr 21, 2026 · 1 revision

NodeSummary Configuration

The NodeSummary.yaml file defines the APPN nodes and their available sensor platforms. It is the primary configuration file read by ProjectBuilder.

File Location

NodeSummary.yaml in the repository root.

Format

nodes:
  - name: "USYD_Narrabri"
    university: "University of Sydney"
    location: "Narrabri, NSW, Australia"
    SensorPlatforms:
      - GOBI
      - HIRES
      - M3M
      - CALVIS
      - PHENOMATE
      - MOLE
      - TEMS
      - PTEMS
      - LITERAL
      - H30T
      - RHIZO

Fields

Field Type Description
name str Node identifier. Format: UniversityAbbr_Location (e.g. USYD_Narrabri)
university str Full university name
location str Location description
SensorPlatforms list of str Sensor platform short names available at this node

Adding a New Node

To add a new node, append another entry under the nodes list:

nodes:
  - name: "USYD_Narrabri"
    university: "University of Sydney"
    location: "Narrabri, NSW, Australia"
    SensorPlatforms:
      - GOBI
      - HIRES

  - name: "UQ_Gatton"
    university: "University of Queensland"
    location: "Gatton, QLD, Australia"
    SensorPlatforms:
      - GOBI
      - PHENOMATE
      - M3M

After editing, run python ProjectBuilder.py to generate the corresponding folder structure and project summary CSV for the new node.

Sensor Platform Names

Sensor platform names should be short, uppercase identifiers. These names are used throughout the folder structure and must be consistent across all configuration files.

When a new sensor is added to a node, the ProjectBuilder script will automatically add the new column to the node's _ProjectsSummary.csv file on the next run.

APPN DataStorage Wiki

Start here

APPN Folder Structure

Guides

Reference

Project

Clone this wiki locally