Skip to content

io.gdx

Read REMIND symbols from a GDX container (via gamspy).

Ported from iampypsa.utils.read_gdx / PyPSA-Eur _helpers.read_remind_data.

list_gdx_symbols(path)

List the symbol names available in a GDX container.

Source code in src/iampypsa/io/gdx.py 
50
51
52
def list_gdx_symbols(path: str | PathLike) -> list[str]:
    """List the symbol names available in a GDX container."""
    return sorted(_open_container(str(path)).data.keys())

read_gdx_scalar(path, symbol)

Read a scalar/string GDX symbol (e.g. model version, run name).

Source code in src/iampypsa/io/gdx.py 
39
40
41
42
43
44
45
46
47
def read_gdx_scalar(path: str | PathLike, symbol: str) -> float | str:
    """Read a scalar/string GDX symbol (e.g. model version, run name)."""
    df = read_gdx_symbol(path, symbol, error_on_empty=False)
    if df is None or df.empty:
        raise ValueError(f"{symbol} has no records in {path}")
    # scalar parameter -> single 'value'; string set -> first element label
    if "value" in df.columns and len(df) == 1:
        return df["value"].iloc[0]
    return df.iloc[0, 0]

read_gdx_symbol(path, symbol, rename_columns=None, error_on_empty=True)

Read one GDX symbol into a tidy long DataFrame.

Source code in src/iampypsa/io/gdx.py 
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
def read_gdx_symbol(
    path: str | PathLike,
    symbol: str,
    rename_columns: Mapping[str, str] | None = None,
    error_on_empty: bool = True,
):
    """Read one GDX symbol into a tidy long DataFrame."""
    data = _open_container(str(path))[symbol]
    df = data.records
    if error_on_empty and (df is None or df.empty):
        raise ValueError(f"{symbol} is empty. In: {path}")
    if df is None:
        return df
    if rename_columns:
        # errors="ignore": candidate fallbacks may have different columns
        # (e.g. the v32 variable has 'level', the p32 parameter has 'value').
        df = df.rename(columns=dict(rename_columns))
    return df