pypsa2smspp 0.0.1__tar.gz

pypsa2smspp-0.0.1/MANIFEST.in

@@ -0,0 +1,2 @@
+include pypsa2smspp/data/*
+include README.md LICENSE

pypsa2smspp-0.0.1/PKG-INFO

@@ -0,0 +1,88 @@
+Metadata-Version: 2.4
+Name: pypsa2smspp
+Version: 0.0.1
+Summary: Bi-directional interface between PyPSA and SMS++
+Author-email: Alessandro Pampado <alessandro.pampado@ing.unipi.it>, Davide Fioriti <davide.fioriti@unipi.it>, Unipi developers <davide.fioriti@unipi.it>
+Project-URL: Homepage, https://github.com/SPSUnipi/pypsa2smspp
+Project-URL: Issues, https://github.com/SPSUnipi/pypsa2smspp/issues
+Classifier: Programming Language :: Python :: 3.12
+Classifier: Programming Language :: Python :: 3.13
+Classifier: License :: OSI Approved :: GNU General Public License v3 or later (GPLv3+)
+Classifier: Operating System :: OS Independent
+Requires-Python: >=3.12
+Description-Content-Type: text/markdown
+Requires-Dist: numpy
+Requires-Dist: pandas<3,>=0.24
+Requires-Dist: pypsa>=1
+Requires-Dist: xarray
+Requires-Dist: openpyxl
+Requires-Dist: pysmspp>=0.0.2
+Provides-Extra: dev
+Requires-Dist: pytest; extra == "dev"
+Requires-Dist: highspy; extra == "dev"
+Requires-Dist: gurobipy; extra == "dev"
+Requires-Dist: coverage; extra == "dev"
+Requires-Dist: pre-commit; extra == "dev"
+Requires-Dist: ncompare; extra == "dev"
+Requires-Dist: mypy; extra == "dev"
+Provides-Extra: docs
+Requires-Dist: numpydoc; extra == "docs"
+Requires-Dist: sphinx; extra == "docs"
+Requires-Dist: sphinx-book-theme; extra == "docs"
+Requires-Dist: sphinx-rtd-theme; extra == "docs"
+Requires-Dist: pydata-sphinx-theme; extra == "docs"
+Requires-Dist: sphinx-reredirects; extra == "docs"
+Requires-Dist: nbsphinx; extra == "docs"
+Requires-Dist: nbsphinx-link; extra == "docs"
+Requires-Dist: scikit-learn; extra == "docs"
+Requires-Dist: ipython; extra == "docs"
+Requires-Dist: ipykernel; extra == "docs"
+
+# pypsa2smspp
+
+[![Tests](https://github.com/SPSUnipi/pypsa2smspp/actions/workflows/test.yml/badge.svg)](https://github.com/SPSUnipi/pypsa2smspp/actions/workflows/test.yml)
+ 
+This package aims at providing a python interface between [PyPSA](https://github.com/PyPSA/pypsa) and [SMS++](https://gitlab.com/smspp/smspp-project) models using a simple python interface.
+The package aims to support:
+- Convert a PyPSA model to SMS++
+- Execute the optimization of the so-created SMS++ model
+- Parse the solution from the SMS++ model to PyPSA
+
+
+## How to develop
+
+1. First, clone the repository using git:
+
+    ```bash
+        git clone https://github.com/SPSUnipi/pypsa2smspp
+    ```
+
+2. Create a virtual environment using venv or conda.
+    For exaample, using venv:
+
+    ```bash
+        python -m venv .venv
+        source .venv/bin/activate
+    ```
+   
+    Alternatively, using conda:
+
+    ```bash
+        conda create -n pypsa2smspp python=3.10
+        conda activate pypsa2smspp
+    ```
+
+3. Install the required packages and pre-commit hooks:
+
+    ```bash
+        pip install -e .[dev]
+        pre-commit install
+    ```
+
+    Note that the `-e` command line option installs the package in editable mode, so that changes to the source code are immediately available in the environment being used. The `[dev]` option installs the packages required for development. The `pre-commit install` command installs the pre-commit hooks, which are used to check the code before committing to ensure code quality standards.
+
+4. Develop and test the code. For testing, please run:
+
+    ```bash
+        pytest
+    ```

pypsa2smspp-0.0.1/README.md

@@ -0,0 +1,48 @@
+# pypsa2smspp
+
+[![Tests](https://github.com/SPSUnipi/pypsa2smspp/actions/workflows/test.yml/badge.svg)](https://github.com/SPSUnipi/pypsa2smspp/actions/workflows/test.yml)
+ 
+This package aims at providing a python interface between [PyPSA](https://github.com/PyPSA/pypsa) and [SMS++](https://gitlab.com/smspp/smspp-project) models using a simple python interface.
+The package aims to support:
+- Convert a PyPSA model to SMS++
+- Execute the optimization of the so-created SMS++ model
+- Parse the solution from the SMS++ model to PyPSA
+
+
+## How to develop
+
+1. First, clone the repository using git:
+
+    ```bash
+        git clone https://github.com/SPSUnipi/pypsa2smspp
+    ```
+
+2. Create a virtual environment using venv or conda.
+    For exaample, using venv:
+
+    ```bash
+        python -m venv .venv
+        source .venv/bin/activate
+    ```
+   
+    Alternatively, using conda:
+
+    ```bash
+        conda create -n pypsa2smspp python=3.10
+        conda activate pypsa2smspp
+    ```
+
+3. Install the required packages and pre-commit hooks:
+
+    ```bash
+        pip install -e .[dev]
+        pre-commit install
+    ```
+
+    Note that the `-e` command line option installs the package in editable mode, so that changes to the source code are immediately available in the environment being used. The `[dev]` option installs the packages required for development. The `pre-commit install` command installs the pre-commit hooks, which are used to check the code before committing to ensure code quality standards.
+
+4. Develop and test the code. For testing, please run:
+
+    ```bash
+        pytest
+    ```

pypsa2smspp-0.0.1/pyproject.toml

@@ -0,0 +1,103 @@
+[build-system]
+requires = ["setuptools>=64"]
+build-backend = "setuptools.build_meta"
+
+[project]
+name = "pypsa2smspp"
+version = "0.0.1"
+authors = [
+  { name="Alessandro Pampado", email="alessandro.pampado@ing.unipi.it"},
+  { name="Davide Fioriti", email="davide.fioriti@unipi.it" },
+  { name="Unipi developers", email="davide.fioriti@unipi.it" },
+]
+description = "Bi-directional interface between PyPSA and SMS++"
+readme = "README.md"
+classifiers = [
+    "Programming Language :: Python :: 3.12",
+    "Programming Language :: Python :: 3.13",
+    "License :: OSI Approved :: GNU General Public License v3 or later (GPLv3+)",
+    "Operating System :: OS Independent",
+]
+
+requires-python = ">=3.12"
+
+dependencies = [
+    "numpy",
+    "pandas>=0.24, <3",
+    "pypsa>=1",
+    "xarray",
+    "openpyxl",
+    "pysmspp>=0.0.2",
+]
+
+[project.urls]
+Homepage = "https://github.com/SPSUnipi/pypsa2smspp"
+Issues = "https://github.com/SPSUnipi/pypsa2smspp/issues"
+
+[project.optional-dependencies]
+dev = [
+    "pytest", 
+    "highspy",
+    "gurobipy",
+    "coverage",
+    "pre-commit",
+    "ncompare",
+    "mypy",
+]
+docs=[
+    "numpydoc",
+    "sphinx",
+    "sphinx-book-theme",
+    "sphinx-rtd-theme",
+    "pydata-sphinx-theme",
+    "sphinx-reredirects",
+    "nbsphinx",
+    "nbsphinx-link",
+    "scikit-learn",
+    "ipython",
+    "ipykernel",
+]
+
+[tool.setuptools]
+packages = ["pypsa2smspp"]
+
+[tool.setuptools_scm]
+version_scheme = "no-guess-dev"
+
+[tool.setuptools.package-data]
+"pysmspp" = ["py.typed"]
+
+# Pytest settings
+
+[tool.pytest.ini_options]   
+filterwarnings = [
+    "error::DeprecationWarning", # Raise all DeprecationWarnings as errors
+    "error::FutureWarning",      # Raise all FutureWarnings as errors
+]
+
+# Coverage settings
+
+[tool.coverage.run]
+branch = true
+source = ["pypsa2smspp"]
+omit = ["test/*"]
+[tool.coverage.report]
+exclude_also = [
+    "if TYPE_CHECKING:",
+]
+
+# Static type checker settings
+[tool.mypy]
+exclude = ['dev/*', 'examples/*', 'doc/*']
+ignore_missing_imports = true
+no_implicit_optional = true
+warn_unused_ignores = true
+show_error_code_links = true
+
+[[tool.mypy.overrides]]
+module = "pypsa2smspp.*"
+disallow_untyped_defs = true
+check_untyped_defs = true
+
+# [tool.setuptools.dynamic]
+# version = {attr = "pysmspp.__version__"}

pypsa2smspp-0.0.1/pypsa2smspp/__init__.py

@@ -0,0 +1,63 @@
+
+"""
+pypsa2smspp package init
+
+Exposes high-level transformation and network correction utilities.
+"""
+
+import logging
+
+logger = logging.getLogger("pypsa2smspp")
+logger.setLevel(logging.INFO)
+
+if not logger.handlers:  # 👈 evita di aggiungere più handler
+    console_handler = logging.StreamHandler()
+    console_handler.setLevel(logging.DEBUG)
+
+    formatter = logging.Formatter(
+        '[%(asctime)s] %(levelname)s - %(name)s - %(message)s'
+    )
+    console_handler.setFormatter(formatter)
+
+    logger.addHandler(console_handler)
+
+# opzionale ma consigliato in una libreria:
+logger.propagate = False
+
+
+
+# Transformation logic (PyPSA ↔ SMS++)
+from pypsa2smspp.transformation import Transformation
+from pypsa2smspp.transformation_config import TransformationConfig
+
+# PyPSA network correction tools
+from pypsa2smspp.network_correction import (
+    clean_marginal_cost,
+    clean_global_constraints,
+    clean_e_sum,
+    clean_efficiency_link,
+    clean_ciclicity_storage,
+    clean_marginal_cost_intermittent,
+    clean_storage_units,
+    clean_stores,
+    parse_txt_file,
+    clean_p_min_pu,
+    one_bus_network,
+)
+
+__all__ = [
+    "Transformation",
+    "TransformationConfig",
+    # network correction tools
+    "clean_marginal_cost",
+    "clean_global_constraints",
+    "clean_e_sum",
+    "clean_efficiency_link",
+    "clean_ciclicity_storage",
+    "clean_marginal_cost_intermittent",
+    "clean_storage_units",
+    "clean_stores",
+    "parse_txt_file",
+    "clean_p_min_pu",
+    "one_bus_network",
+]

pypsa2smspp-0.0.1/pypsa2smspp/constants.py

@@ -0,0 +1,59 @@
+# -*- coding: utf-8 -*-
+"""
+Created on Thu Jun 26 15:50:01 2025
+
+@author: aless
+"""
+
+"""
+constants.py
+
+This module contains structural constants used throughout the PyPSA2SMSpp 
+transformation process. These values define generic mappings and categories
+used repeatedly in the Transformation class and related utilities.
+
+They are not meant to be modified by the user and do not depend on any 
+specific instance or configuration of the network.
+"""
+
+# Dictionary mapping internal shorthand dimensions to full SMS++ dimension names
+conversion_dict = {
+    "T": "TimeHorizon",
+    "NU": "NumberUnits",
+    "NE": "NumberElectricalGenerators",
+    "N": "NumberNodes",
+    "L": "NumberLines",
+    "Li": "Links",
+    "NA": "NumberArcs",
+    "NR": "NumberReservoirs",
+    "NP": "TotalNumberPieces",
+    "Nass": "NumAssets",
+    "NB": "NumberBranches",
+    "NDL": "NumberDesignLines",
+    "NDLL": "NumberDesignLines_lines",
+    "NDLLi": "NumberDesignLines_links",
+    "1": 1
+}
+
+# Mapping from PyPSA component types to their nominal attribute
+nominal_attrs = {
+    "Generator": "p_nom",
+    "Line": "s_nom",
+    "Transformer": "s_nom",
+    "Link": "p_nom",
+    "Store": "e_nom",
+    "StorageUnit": "p_nom",
+}
+
+# List of renewable carriers used to identify IntermittentUnitBlocks
+renewable_carriers = [
+    "solar",
+    "solar-hsat",
+    "onwind",
+    "offwind-ac",
+    "offwind-dc",
+    "offwind-float",
+    "PV",
+    "wind",
+    "ror"
+]

pypsa2smspp-0.0.1/pypsa2smspp/data/config_default.yaml

@@ -0,0 +1,22 @@
+transformation:
+    merge_links: true
+    expansion_ucblock: false # To include with investmentblock... Collect everything with mode
+    max_hours_stores: 1
+
+run:
+    mode: investmentblock  # ucblock | investmentblock
+
+smspp:
+    ucblock:
+        output_prefix: uc
+        template: UCBlock/uc_solverconfig_grb
+    investmentblock:
+        output_prefix: inv
+        template: InvestmentBlock/BSPar.txt
+        inner_block_name: InvestmentBlock
+    log_executable_call: true
+
+io:
+    workdir: output
+    name: test_case
+    overwrite: true

pypsa2smspp-0.0.1/pypsa2smspp/inverse.py

@@ -0,0 +1,143 @@
+# -*- coding: utf-8 -*-
+"""
+Created on Thu Jun 26 15:55:15 2025
+
+@author: aless
+"""
+
+"""
+inverse.py
+
+This module handles the inverse transformation from an SMS++ solution 
+back into a PyPSA-compatible xarray.Dataset. It reconstructs time-series 
+and scalar variables from SMS unit blocks and prepares them for use with 
+assign_solution in PyPSA.
+"""
+
+import numpy as np
+import xarray as xr
+
+
+def normalize_key(key: str) -> str:
+    """
+    Normalizes a key string by converting to lowercase and replacing spaces with underscores.
+    """
+    return key.lower().replace(" ", "_")
+
+
+def component_definition(n, unit_block: dict) -> str:
+    """
+    Maps a unit block type to its corresponding PyPSA component name.
+    """
+    block = unit_block['block']
+    match block:
+        case "IntermittentUnitBlock":
+            return "Generator"
+        case "ThermalUnitBlock":
+            return "Generator"
+        case "HydroUnitBlock":
+            return "StorageUnit"
+        case "BatteryUnitBlock":
+            return "StorageUnit" if unit_block['name'] in n.storage_units.index else "Store"
+        case "DCNetworkBlock_lines":
+            return "Line"
+        case "DCNetworkBlock_links":
+            return "Link"
+        case "SlackUnitBlock":
+            return "Generator"
+        case _:
+            raise ValueError(f"Unknown unit block type: {block}")
+
+
+def evaluate_function(func, normalized_keys, unit_block, df):
+    """
+    Evaluates a callable inverse function by extracting arguments from unit block or network.
+    """
+    param_names = func.__code__.co_varnames[:func.__code__.co_argcount]
+    args = []
+    for param in param_names:
+        param = normalize_key(param)
+        if param in normalized_keys:
+            args.append(unit_block[normalized_keys[param]])
+        else:
+            args.append(df.loc[unit_block['name']][param])
+    return func(*args)
+
+
+def dataarray_components(n, value, component, unit_block, key):
+    """
+    Build xarray dims/coords compliant with PyPSA 1.0 assign_solution():
+    - static per-unit: dims -> ('name',)
+    - time series:     dims -> ('snapshot','name')
+    """
+    # Unmask masked arrays; use NaN for masked scalars
+    if isinstance(value, np.ma.MaskedArray):
+        value = value.filled(np.nan)
+
+    value = np.asarray(value)
+    unit_name = unit_block["name"]
+
+    if value.ndim == 0:
+        # scalar -> one value for this unit: ('name',)
+        value = value.reshape(1)
+        dims = ["name"]
+        coords = {"name": [unit_name]}
+
+    elif value.ndim == 1:
+        if len(value) == len(n.snapshots):
+            # (T,) -> ('snapshot','name')
+            value = value[:, np.newaxis]  # (T,1)
+            dims = ["snapshot", "name"]
+            coords = {"snapshot": n.snapshots, "name": [unit_name]}
+        else:
+            # vector but not time-based -> treat as per-unit static ('name',)
+            # (se è un vettore con più elementi non-temporali, somma o valida prima)
+            value = np.array([value.sum()]) if value.size > 1 else value.reshape(1)
+            dims = ["name"]
+            coords = {"name": [unit_name]}
+
+    elif value.ndim == 2:
+        T = len(n.snapshots)
+        if value.shape == (T, 1):
+            dims = ["snapshot", "name"]
+            coords = {"snapshot": n.snapshots, "name": [unit_name]}
+        elif value.shape == (1, T):
+            value = value.T
+            dims = ["snapshot", "name"]
+            coords = {"snapshot": n.snapshots, "name": [unit_name]}
+        else:
+            raise ValueError(f"Unsupported shape for variable {key}: {value.shape}")
+    else:
+        raise ValueError(f"Unsupported ndim for variable {key}: {value.ndim}")
+
+    var_name = f"{component}-{key}"  # e.g., 'Generator-p', 'Store-e_nom', 'Link-p'
+    return value, dims, coords, var_name
+
+
+
+def block_to_dataarrays(n, unit_name, unit_block, component, config) -> dict:
+    """
+    Transforms a unit block into a dictionary of DataArrays.
+    """
+    attr_name = f"{unit_block['block']}_inverse"
+    converted_dict = {}
+    normalized_keys = {normalize_key(k): k for k in unit_block.keys()}
+
+    if hasattr(config, attr_name):
+        unitblock_parameters = getattr(config, attr_name)
+    else:
+        print(f"Block {unit_block['block']} not yet implemented")
+        return {}
+
+    df = getattr(n, config.component_mapping[component])
+
+    for key, func in unitblock_parameters.items():
+        if callable(func):
+            value = evaluate_function(func, normalized_keys, unit_block, df)
+            if isinstance(value, np.ndarray) and value.ndim == 2 and all(dim > 1 for dim in value.shape):
+                value = value.sum(axis=0)
+            value, dims, coords, var_name = dataarray_components(n, value, component, unit_block, key)
+            converted_dict[var_name] = xr.DataArray(value, dims=dims, coords=coords, name=var_name)
+
+    return converted_dict
+