Skip to content

manifest

tit.opt.flex.manifest

Flex-search output manifest (flex_meta.json).

Every flex-search run writes a manifest alongside its outputs. This is the single source of truth for run metadata -- downstream consumers (simulator, GUI) read this instead of parsing folder names.

Public API

write_manifest Serialize run metadata to flex_meta.json. read_manifest Load and parse an existing manifest. MANIFEST_FILENAME Canonical filename ("flex_meta.json"). MANIFEST_VERSION Integer schema version for forward compatibility.

See Also

tit.opt.flex.flex.run_flex_search : Writes a manifest after each run.

write_manifest 

write_manifest(output_folder: str, config: FlexConfig, result: FlexResult, label: str, pareto_data: dict | None = None) -> str

Write flex_meta.json to output_folder.

Parameters

output_folder : str Directory to write the manifest into. config : FlexConfig The configuration used for this run. result : FlexResult The result from the completed run. label : str Human-readable summary label for GUI display. pareto_data : dict or None Optional dict with Pareto sweep summary (for sweep runs).

Returns

str Absolute path to the written manifest file.

See Also

read_manifest : Load a previously written manifest.

Source code in tit/opt/flex/manifest.py 
 33
 34
 35
 36
 37
 38
 39
 40
 41
 42
 43
 44
 45
 46
 47
 48
 49
 50
 51
 52
 53
 54
 55
 56
 57
 58
 59
 60
 61
 62
 63
 64
 65
 66
 67
 68
 69
 70
 71
 72
 73
 74
 75
 76
 77
 78
 79
 80
 81
 82
 83
 84
 85
 86
 87
 88
 89
 90
 91
 92
 93
 94
 95
 96
 97
 98
 99
100
101
102
103
104
105
106
107
def write_manifest(
    output_folder: str,
    config: FlexConfig,
    result: FlexResult,
    label: str,
    pareto_data: dict | None = None,
) -> str:
    """Write ``flex_meta.json`` to *output_folder*.

    Parameters
    ----------
    output_folder : str
        Directory to write the manifest into.
    config : FlexConfig
        The configuration used for this run.
    result : FlexResult
        The result from the completed run.
    label : str
        Human-readable summary label for GUI display.
    pareto_data : dict or None
        Optional dict with Pareto sweep summary (for sweep runs).

    Returns
    -------
    str
        Absolute path to the written manifest file.

    See Also
    --------
    read_manifest : Load a previously written manifest.
    """
    data = {
        "version": MANIFEST_VERSION,
        "created": datetime.now().isoformat(timespec="seconds"),
        "subject_id": config.subject_id,
        "goal": (
            str(config.goal.value)
            if hasattr(config.goal, "value")
            else str(config.goal)
        ),
        "postproc": (
            str(config.postproc.value)
            if hasattr(config.postproc, "value")
            else str(config.postproc)
        ),
        "current_mA": config.current_mA,
        "electrode": {
            "shape": config.electrode.shape,
            "dimensions": list(config.electrode.dimensions),
            "gel_thickness": config.electrode.gel_thickness,
        },
        "roi": _serialize_roi(config.roi),
        "non_roi": _serialize_roi(config.non_roi) if config.non_roi else None,
        "non_roi_method": (
            str(config.non_roi_method.value)
            if config.non_roi_method and hasattr(config.non_roi_method, "value")
            else str(config.non_roi_method) if config.non_roi_method else None
        ),
        "thresholds": config.thresholds,
        "n_multistart": config.n_multistart,
        "min_electrode_distance": config.min_electrode_distance,
        "result": {
            "success": result.success,
            "best_value": result.best_value,
            "best_run_index": result.best_run_index,
            "all_values": result.function_values,
        },
        "pareto": pareto_data,
        "label": label,
    }

    path = os.path.join(output_folder, MANIFEST_FILENAME)
    with open(path, "w") as f:
        json.dump(data, f, indent=2)
    return path

read_manifest 

read_manifest(output_folder: str) -> dict | None

Read flex_meta.json from a folder.

Parameters

output_folder : str Directory that should contain the manifest.

Returns

dict or None Parsed manifest dict, or None if missing or invalid.

See Also

write_manifest : Create a new manifest.

Source code in tit/opt/flex/manifest.py 
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
def read_manifest(output_folder: str) -> dict | None:
    """Read ``flex_meta.json`` from a folder.

    Parameters
    ----------
    output_folder : str
        Directory that should contain the manifest.

    Returns
    -------
    dict or None
        Parsed manifest dict, or ``None`` if missing or invalid.

    See Also
    --------
    write_manifest : Create a new manifest.
    """
    path = os.path.join(output_folder, MANIFEST_FILENAME)
    if not os.path.isfile(path):
        return None
    try:
        with open(path) as f:
            return json.load(f)
    except (json.JSONDecodeError, OSError):
        return None