NREL-ditto 0.0.7__tar.gz

nrel_ditto-0.0.7/.gitignore

@@ -0,0 +1,178 @@
+# Byte-compiled / optimized / DLL files
+__pycache__/
+*.py[cod]
+*$py.class
+
+tests/dump_from_tests/
+
+# C extensions
+*.so
+
+# Distribution / packaging
+.Python
+build/
+develop-eggs/
+dist/
+downloads/
+eggs/
+.eggs/
+lib/
+lib64/
+parts/
+sdist/
+var/
+wheels/
+share/python-wheels/
+*.egg-info/
+.installed.cfg
+*.egg
+MANIFEST
+
+# PyInstaller
+#  Usually these files are written by a python script from a template
+#  before PyInstaller builds the exe, so as to inject date/other infos into it.
+*.manifest
+*.spec
+
+# Installer logs
+pip-log.txt
+pip-delete-this-directory.txt
+
+# Unit test / coverage reports
+htmlcov/
+.tox/
+.nox/
+.coverage
+.coverage.*
+.cache
+nosetests.xml
+coverage.xml
+*.cover
+*.py,cover
+.hypothesis/
+.pytest_cache/
+cover/
+
+# Translations
+*.mo
+*.pot
+
+# Django stuff:
+*.log
+local_settings.py
+db.sqlite3
+db.sqlite3-journal
+
+# Flask stuff:
+instance/
+.webassets-cache
+
+# Scrapy stuff:
+.scrapy
+
+# Sphinx documentation
+docs/_build/
+
+# PyBuilder
+.pybuilder/
+target/
+tests/dump_from_tests/
+
+# Jupyter Notebook
+.ipynb_checkpoints
+
+# IPython
+profile_default/
+ipython_config.py
+
+# pyenv
+#   For a library or package, you might want to ignore these files since the code is
+#   intended to run in multiple environments; otherwise, check them in:
+# .python-version
+
+# pipenv
+#   According to pypa/pipenv#598, it is recommended to include Pipfile.lock in version control.
+#   However, in case of collaboration, if having platform-specific dependencies or dependencies
+#   having no cross-platform support, pipenv may install dependencies that don't work, or not
+#   install all needed dependencies.
+#Pipfile.lock
+
+# poetry
+#   Similar to Pipfile.lock, it is generally recommended to include poetry.lock in version control.
+#   This is especially recommended for binary packages to ensure reproducibility, and is more
+#   commonly ignored for libraries.
+#   https://python-poetry.org/docs/basic-usage/#commit-your-poetrylock-file-to-version-control
+#poetry.lock
+
+# pdm
+#   Similar to Pipfile.lock, it is generally recommended to include pdm.lock in version control.
+#pdm.lock
+#   pdm stores project-wide configurations in .pdm.toml, but it is recommended to not include it
+#   in version control.
+#   https://pdm.fming.dev/#use-with-ide
+.pdm.toml
+
+# PEP 582; used by e.g. github.com/David-OConnor/pyflow and github.com/pdm-project/pdm
+__pypackages__/
+
+# Celery stuff
+celerybeat-schedule
+celerybeat.pid
+
+# SageMath parsed files
+*.sage.py
+
+# Environments
+.env
+.venv
+env/
+venv/
+ENV/
+env.bak/
+venv.bak/
+
+# Spyder project settings
+.spyderproject
+.spyproject
+
+# Rope project settings
+.ropeproject
+
+# mkdocs documentation
+/site
+
+# mypy
+.mypy_cache/
+.dmypy.json
+dmypy.json
+
+# Pyre type checker
+.pyre/
+
+# pytype static type analyzer
+.pytype/
+
+# Cython debug symbols
+cython_debug/
+
+# PyCharm
+#  JetBrains specific template is maintained in a separate JetBrains.gitignore that can
+#  be found at https://github.com/github/gitignore/blob/main/Global/JetBrains.gitignore
+#  and can be added to the global gitignore or merged into this file.  For a more nuclear
+#  option (not recommended) you can uncomment the following to ignore the entire idea folder.
+#.idea/
+
+
+#ditto ignores
+
+*.csv
+*.json
+*.txt
+*.TXT
+*.swp
+*.swo
+*.DSV
+*.dsv
+*.dbl
+*.DBL
+.qodo

nrel_ditto-0.0.7/PKG-INFO

@@ -0,0 +1,30 @@
+Metadata-Version: 2.4
+Name: NREL-ditto
+Version: 0.0.7
+Summary: Many to one to many distrbution system model converter 
+Project-URL: Documentation, https://github.com/NREL-Distribution-Suites/ditto#readme
+Project-URL: Issues, https://github.com/NREL-Distribution-Suites/ditto/issues
+Project-URL: Source, https://github.com/NREL-Distribution-Suites/ditto
+Author-email: Aadil Latif <aadil.latif@gmail.com>
+License-Expression: MIT
+Classifier: Development Status :: 4 - Beta
+Classifier: Programming Language :: Python
+Classifier: Programming Language :: Python :: 3.10
+Classifier: Programming Language :: Python :: 3.11
+Classifier: Programming Language :: Python :: 3.12
+Classifier: Programming Language :: Python :: Implementation :: CPython
+Classifier: Programming Language :: Python :: Implementation :: PyPy
+Requires-Python: >=3.11
+Requires-Dist: grid-data-models==2.0.0
+Requires-Dist: nrel-altdss-schema==0.0.1
+Requires-Dist: opendssdirect-py
+Requires-Dist: rdflib
+Provides-Extra: dev
+Requires-Dist: pytest; extra == 'dev'
+Requires-Dist: ruff; extra == 'dev'
+Provides-Extra: doc
+Requires-Dist: autodoc-pydantic; extra == 'doc'
+Requires-Dist: myst-parser; extra == 'doc'
+Requires-Dist: pydata-sphinx-theme; extra == 'doc'
+Requires-Dist: sphinx; extra == 'doc'
+Requires-Dist: sphinxcontrib-mermaid; extra == 'doc'

nrel_ditto-0.0.7/pyproject.toml

@@ -0,0 +1,113 @@
+[build-system]
+requires = ["hatchling"]
+build-backend = "hatchling.build"
+
+[project]
+name = "NREL-ditto"
+dynamic = ["version"]
+description = 'Many to one to many distrbution system model converter '
+requires-python = ">=3.11"
+license = "MIT"
+keywords = []
+authors = [
+  { name = "Aadil Latif", email = "aadil.latif@gmail.com" },
+]
+classifiers = [
+  "Development Status :: 4 - Beta",
+  "Programming Language :: Python",
+  "Programming Language :: Python :: 3.10",
+  "Programming Language :: Python :: 3.11",
+  "Programming Language :: Python :: 3.12",
+  "Programming Language :: Python :: Implementation :: CPython",
+  "Programming Language :: Python :: Implementation :: PyPy",
+]
+dependencies = [
+  "opendssdirect.py",
+  "grid-data-models==2.0.0",
+  "rdflib",
+  "NREL-altdss-schema==0.0.1",
+]
+
+[project.urls]
+Documentation = "https://github.com/NREL-Distribution-Suites/ditto#readme"
+Issues = "https://github.com/NREL-Distribution-Suites/ditto/issues"
+Source = "https://github.com/NREL-Distribution-Suites/ditto"
+
+[tool.hatch.version]
+path = "src/ditto/__init__.py"
+
+[project.optional-dependencies]
+doc = [
+  "sphinxcontrib-mermaid",
+  "pydata-sphinx-theme",
+  "autodoc_pydantic",
+  "myst-parser",
+  "sphinx",
+  ]
+dev = [
+  "pytest",
+  "ruff"
+]
+
+
+
+[tool.pytest.ini_options]
+minversion = "6.0"
+addopts = "-ra"
+testpaths = [
+    "tests",
+]
+
+[tool.ruff]
+# Exclude a variety of commonly ignored directories.
+exclude = [
+    ".git",
+    ".ruff_cache",
+    ".venv",
+    "_build",
+    "build",
+    "dist",
+    "env",
+    "venv",
+]
+
+line-length = 99
+indent-width = 4
+target-version = "py311"
+
+[tool.ruff.lint]
+# Enable Pyflakes (`F`) and a subset of the pycodestyle (`E`)  codes by default.
+select = [
+    "C901",  # McCabe complexity
+    "E4",  # Subset of pycodestyle (E)
+    "E7",
+    "E9",
+    "F",  # Pyflakes
+    "W",  # pycodestyle warnings
+]
+ignore = []
+
+# Allow fix for all enabled rules (when `--fix`) is provided.
+fixable = ["ALL"]
+unfixable = []
+
+[tool.ruff.format]
+quote-style = "double"
+indent-style = "space"
+skip-magic-trailing-comma = false
+line-ending = "auto"
+docstring-code-format = true
+docstring-code-line-length = "dynamic"
+
+[tool.ruff.lint.per-file-ignores]
+"__init__.py" = ["E402", "F401"]
+"**/{tests,docs,tools}/*" = ["E402"]
+
+[tool.hatch.metadata]
+allow-direct-references = true
+
+[tool.hatch.build.targets.wheel]
+packages = ["src/ditto"]
+
+[tool.hatch.build.targets.sdist]
+include = ["src/ditto"]

nrel_ditto-0.0.7/src/ditto/__init__.py

@@ -0,0 +1 @@
+__version__ = "0.0.7"

nrel_ditto-0.0.7/src/ditto/enumerations.py

@@ -0,0 +1,18 @@
+from enum import Enum
+
+
+class OpenDSSFileTypes(str, Enum):
+    MASTER_FILE = "Master.dss"
+    COORDINATE_FILE = "BusCoords.dss"
+    WIRES_FILE = "WireData.dss"
+    LINE_GEOMETRIES_FILE = "LineGeometry.dss"
+    LINECODES_FILE = "LineCodes.dss"
+    SWITCH_CODES_FILE = "SwitchCodes.dss"
+    FUSE_CODES_FILE = "FuseCodes.dss"
+    TRANSFORMERS_FILE = "Transformers.dss"
+    CAPACITORS_FILE = "Capacitors.dss"
+    LINES_FILE = "Lines.dss"
+    LOADS_FILE = "Loads.dss"
+    SWITCH_FILE = "Switches.dss"
+    FUSE_FILE = "Fuses.dss"
+    REGULATOR_CONTROLLERS_FILE = "RegControllers.dss"

nrel_ditto-0.0.7/src/ditto/readers/cim_iec_61968_13/__init__.py

@@ -0,0 +1,31 @@
+from ditto.readers.cim_iec_61968_13.components.distribution_bus import DistributionBusMapper
+from ditto.readers.cim_iec_61968_13.components.distribution_capacitor import (
+    DistributionCapacitorMapper,
+)
+from ditto.readers.cim_iec_61968_13.components.distribution_load import DistributionLoadMapper
+from ditto.readers.cim_iec_61968_13.components.distribution_transformer import (
+    DistributionTransformerMapper,
+)
+from ditto.readers.cim_iec_61968_13.equipment.distribution_transformer_equipment import (
+    DistributionTransformerEquipmentMapper,
+)
+from ditto.readers.cim_iec_61968_13.equipment.matrix_branch_equipment import (
+    MatrixImpedanceBranchEquipmentMapper,
+)
+from ditto.readers.cim_iec_61968_13.components.matrix_branch import MatrixImpedanceBranchMapper
+from ditto.readers.cim_iec_61968_13.components.distribution_voltage_source import (
+    DistributionVoltageSourceMapper,
+)
+from ditto.readers.cim_iec_61968_13.equipment.voltage_source_equipment import (
+    VoltageSourceEquipmentMapper,
+)
+from ditto.readers.cim_iec_61968_13.controllers.regulator_controller import (
+    RegulatorControllerMapper,
+)
+from ditto.readers.cim_iec_61968_13.components.distribution_regulator import (
+    DistributionRegulatorMapper,
+)
+
+from ditto.readers.cim_iec_61968_13.components.matrix_impedance_switch import (
+    MatrixImpedanceSwitchMapper,
+)

nrel_ditto-0.0.7/src/ditto/readers/cim_iec_61968_13/cim_mapper.py

@@ -0,0 +1,8 @@
+from abc import ABC
+
+from gdm.distribution import DistributionSystem
+
+
+class CimMapper(ABC):
+    def __init__(self, system: DistributionSystem):
+        self.system = system

nrel_ditto-0.0.7/src/ditto/readers/cim_iec_61968_13/common.py

@@ -0,0 +1,3 @@
+from gdm.distribution.enums import Phase
+
+phase_mapper = {"A": Phase.A, "B": Phase.B, "C": Phase.C}

nrel_ditto-0.0.7/src/ditto/readers/cim_iec_61968_13/components/distribution_bus.py

@@ -0,0 +1,61 @@
+from gdm.distribution.components import DistributionBus
+from gdm.distribution.common import VoltageLimitSet
+from gdm.quantities import PositiveVoltage
+from infrasys.location import Location
+from gdm.distribution.enums import (
+    VoltageTypes,
+    LimitType,
+)
+
+from ditto.readers.cim_iec_61968_13.cim_mapper import CimMapper
+from ditto.readers.cim_iec_61968_13.common import phase_mapper
+
+
+class DistributionBusMapper(CimMapper):
+    def __init__(self, system):
+        super().__init__(system)
+
+    def parse(self, row):
+        phases = row["phase"].split(",")
+        self.n_phase = len(phases)
+        return DistributionBus(
+            name=self.map_name(row),
+            coordinate=self.map_coordinate(row),
+            rated_voltage=self.map_rated_voltage(row),
+            phases=self.map_phases(row),
+            voltagelimits=self.map_voltagelimits(row),
+            voltage_type=self.map_voltage_type(row),
+        )
+
+    def map_name(self, row):
+        return row["bus"]
+
+    def map_coordinate(self, row):
+        X, Y = row["x"], row["y"]
+        crs = None
+        location = Location(x=X, y=Y, crs=crs)
+        return location
+
+    # Nominal voltage is only defined by transformers
+    def map_rated_voltage(self, row):
+        return PositiveVoltage(float(row["rated_voltage"]) / 1.732, "volt")
+
+    def map_phases(self, row):
+        phases = row["phase"].split(",")
+        all_phases = [phase_mapper[phase] for phase in phases]
+        return all_phases
+
+    def map_voltagelimits(self, row):
+        return [
+            VoltageLimitSet(
+                limit_type=LimitType.MIN,
+                value=PositiveVoltage(float(row["rated_voltage"]) * 0.95, "volt"),
+            ),
+            VoltageLimitSet(
+                limit_type=LimitType.MAX,
+                value=PositiveVoltage(float(row["rated_voltage"]) * 1.05, "volt"),
+            ),
+        ]
+
+    def map_voltage_type(self, row):
+        return VoltageTypes.LINE_TO_GROUND.value

nrel_ditto-0.0.7/src/ditto/readers/cim_iec_61968_13/components/distribution_capacitor.py

@@ -0,0 +1,43 @@
+from gdm.distribution.components import DistributionBus, DistributionCapacitor
+
+from ditto.readers.cim_iec_61968_13.equipment.capacitor_equipment import CapacitorEquipmentMapper
+from ditto.readers.cim_iec_61968_13.cim_mapper import CimMapper
+from ditto.readers.cim_iec_61968_13.common import phase_mapper
+
+
+class DistributionCapacitorMapper(CimMapper):
+    def __init__(self, system):
+        super().__init__(system)
+
+    def parse(self, row):
+        return DistributionCapacitor(
+            name=self.map_name(row),
+            bus=self.map_bus(row),
+            phases=self.map_phases(row),
+            controllers=self.map_controllers(row),
+            equipment=self.map_equipment(row),
+        )
+
+    def map_name(self, row):
+        return row["capacitor"]
+
+    def map_bus(self, row):
+        bus_name = row["bus"]
+        bus = self.system.get_component(component_type=DistributionBus, name=bus_name)
+        return bus
+
+    def map_phases(self, row):
+        phases = row["phase"]
+        if phases is None:
+            phases = ["A", "B", "C"]
+        else:
+            phases = phases.split(",")
+        return [phase_mapper[phase] for phase in phases]
+
+    def map_controllers(self, row):
+        return []
+
+    def map_equipment(self, row):
+        mapper = CapacitorEquipmentMapper(self.system)
+        equipment = mapper.parse(row)
+        return equipment

nrel_ditto-0.0.7/src/ditto/readers/cim_iec_61968_13/components/distribution_load.py

@@ -0,0 +1,48 @@
+from gdm.distribution.components import DistributionLoad, DistributionBus
+
+from ditto.readers.cim_iec_61968_13.equipment.load_equipment import LoadEquipmentMapper
+from ditto.readers.cim_iec_61968_13.cim_mapper import CimMapper
+from ditto.readers.cim_iec_61968_13.common import phase_mapper
+
+
+class DistributionLoadMapper(CimMapper):
+    def __init__(self, system):
+        super().__init__(system)
+
+    def parse(self, row):
+        return DistributionLoad(
+            name=self.map_name(row),
+            bus=self.map_bus(row),
+            phases=self.map_phases(row),
+            equipment=self.map_equipment(row),
+        )
+
+    def map_name(self, row):
+        return row["load"]
+
+    def map_bus(self, row):
+        bus_name = row["bus"]
+        bus = self.system.get_component(component_type=DistributionBus, name=bus_name)
+        return bus
+
+    def map_phases(self, row):
+        bus_name = row["bus"]
+        bus = self.system.get_component(component_type=DistributionBus, name=bus_name)
+        phases = row["phase"]
+
+        if phases is None:
+            phases = ["A", "B", "C"]
+        else:
+            phases = phases.split(",")
+        phases = [phase_mapper[phase] for phase in phases]
+
+        if row["grounded"] == "false" and len(phases) == 1:
+            diff = list(set(bus.phases).difference(phases))
+            if diff:
+                phases.append(sorted(diff)[0].value)
+        return phases
+
+    def map_equipment(self, row):
+        mapper = LoadEquipmentMapper(self.system)
+        equipment = mapper.parse(row)
+        return equipment

nrel_ditto-0.0.7/src/ditto/readers/cim_iec_61968_13/components/distribution_regulator.py

@@ -0,0 +1,56 @@
+from gdm.distribution.components import DistributionBus, DistributionRegulator
+from gdm.distribution.controllers import RegulatorController
+from gdm.distribution.enums import Phase
+
+from ditto.readers.cim_iec_61968_13.equipment.distribution_transformer_equipment import (
+    DistributionTransformerEquipmentMapper,
+)
+
+from ditto.readers.cim_iec_61968_13.cim_mapper import CimMapper
+from ditto.readers.cim_iec_61968_13.common import phase_mapper
+
+
+class DistributionRegulatorMapper(CimMapper):
+    def __init__(self, system):
+        super().__init__(system)
+
+    def parse(self, row):
+        return DistributionRegulator(
+            name=self.map_name(row),
+            buses=self.map_bus(row),
+            equipment=self.map_equipment(row),
+            winding_phases=self.map_winding_phases(row),
+            controllers=self.map_controllers(row),
+        )
+
+    def map_name(self, row):
+        return row["xfmr"]
+
+    def map_winding_phases(self, row):
+        if "wdg_1_phase" in row:
+            phase_1 = [phase_mapper[phs] for phs in row["wdg_1_phase"].replace("N", "")]
+        else:
+            phase_1 = [Phase.A, Phase.B, Phase.C]
+
+        if "wdg_2_phase" in row:
+            phase_2 = [phase_mapper[phs] for phs in row["wdg_2_phase"].replace("N", "")]
+        else:
+            phase_2 = [Phase.A, Phase.B, Phase.C]
+
+        return [phase_1, phase_2]
+
+    def map_bus(self, row):
+        bus_1_name = row["bus_1"]
+        bus_2_name = row["bus_2"]
+        bus_1 = self.system.get_component(DistributionBus, bus_1_name)
+        bus_2 = self.system.get_component(DistributionBus, bus_2_name)
+        return [bus_1, bus_2]
+
+    def map_equipment(self, row):
+        xfmr_equip_mapper = DistributionTransformerEquipmentMapper(self.system)
+        xfmr_equip = xfmr_equip_mapper.parse(row)
+        return xfmr_equip
+
+    def map_controllers(self, row):
+        reg_controllers = self.system.get_component(RegulatorController, row["xfmr"])
+        return [reg_controllers]

nrel_ditto-0.0.7/src/ditto/readers/cim_iec_61968_13/components/distribution_transformer.py

@@ -0,0 +1,38 @@
+from gdm.distribution.components import DistributionBus, DistributionTransformer
+from gdm.distribution.enums import Phase
+
+from ditto.readers.cim_iec_61968_13.equipment.distribution_transformer_equipment import (
+    DistributionTransformerEquipmentMapper,
+)
+from ditto.readers.cim_iec_61968_13.cim_mapper import CimMapper
+
+
+class DistributionTransformerMapper(CimMapper):
+    def __init__(self, system):
+        super().__init__(system)
+
+    def parse(self, row):
+        return DistributionTransformer(
+            name=self.map_name(row),
+            buses=self.map_bus(row),
+            equipment=self.map_equipment(row),
+            winding_phases=self.map_winding_phases(row),
+        )
+
+    def map_name(self, row):
+        return row["xfmr"]
+
+    def map_winding_phases(self, row):
+        return [[Phase.A, Phase.B, Phase.C], [Phase.A, Phase.B, Phase.C]]
+
+    def map_bus(self, row):
+        bus_1_name = row["bus_1"]
+        bus_2_name = row["bus_2"]
+        bus_1 = self.system.get_component(DistributionBus, bus_1_name)
+        bus_2 = self.system.get_component(DistributionBus, bus_2_name)
+        return [bus_1, bus_2]
+
+    def map_equipment(self, row):
+        xfmr_equip_mapper = DistributionTransformerEquipmentMapper(self.system)
+        xfmr_equip = xfmr_equip_mapper.parse(row)
+        return xfmr_equip

nrel_ditto-0.0.7/src/ditto/readers/cim_iec_61968_13/components/distribution_voltage_source.py

@@ -0,0 +1,36 @@
+from gdm.distribution.components import DistributionBus, DistributionVoltageSource
+
+from ditto.readers.cim_iec_61968_13.equipment.voltage_source_equipment import (
+    VoltageSourceEquipmentMapper,
+)
+from ditto.readers.cim_iec_61968_13.cim_mapper import CimMapper
+from ditto.readers.cim_iec_61968_13.common import phase_mapper
+
+
+class DistributionVoltageSourceMapper(CimMapper):
+    def __init__(self, system):
+        super().__init__(system)
+
+    def parse(self, row):
+        return DistributionVoltageSource(
+            name=self.map_name(row),
+            bus=self.map_bus(row),
+            phases=self.map_phases(),
+            equipment=self.map_equipment(row),
+        )
+
+    def map_name(self, row):
+        return row["source"]
+
+    def map_bus(self, row):
+        bus_name = row["bus"]
+        bus = self.system.get_component(component_type=DistributionBus, name=bus_name)
+        return bus
+
+    def map_phases(self):
+        return [phase_mapper[phase] for phase in ["A", "B", "C"]]
+
+    def map_equipment(self, row):
+        mapper = VoltageSourceEquipmentMapper(self.system)
+        equipment = mapper.parse(row)
+        return equipment