Documentation
Documentation

DIMS documentation

Technical reference for the DIMS core, its self-registering tabs, the Python analyses and the study repositories that pin them.

Every page here is generated from the markdown in dims-network/dims at v1.0.1, so it describes the code as released rather than as remembered. New to DIMS? Start with Getting started.

Sections

Getting started

From raw data to a running dashboard, with the commands that work.

Architecture

One core repository, self-registering tabs, and one small repo per study pinning a released version.

Asset layout

Where every file goes, what an analysis writes, and how a payload is reduced.

Analysis output

What an analysis result must contain, and why: the bounds, the encoding, the window, asked-for beside achieved, and which significance level is the right one.

Wavelet coherence

What the chance level is, what it assumes, and how to read a coherence value.

Public and private data

How a study declares its visibility, and the guards that enforce it.

Writing a tab

The contract a tab implements, and the acceptance checks for it.

Writing an analysis

A study-owned script or a registered step — which to write, and how.

A study repository

What a case repo holds, what a version bump regenerates, and what it never touches.

Generated from tools/SOURCE.json at v1.0.1. Edit it there, not here.