grid-data-models 0.0.1__tar.gz

grid_data_models-0.0.1/.github/workflows/gh-pages.yml

@@ -0,0 +1,31 @@
+name: Documentation
+
+on:
+  push:
+    branches: [main]
+
+jobs:
+  make-pages:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v4
+      - name: select python version
+        uses: actions/setup-python@v5
+        with:
+          python-version: "3.11"
+      - name: install dependencies
+        run: |
+          python -m pip install --upgrade pip
+          python -m pip install ".[doc]"
+      - name: build documentation
+        run: |
+          cd docs
+          make clean
+          make html
+      - name: deploy
+        uses: peaceiris/actions-gh-pages@v3.6.1
+        with:
+          github_token: ${{ secrets.GITHUB_TOKEN }}
+          publish_dir: ./docs/_build/html
+          force_orphan: true
+          full_commit_message: ${{ github.event.head_commit.message }}

grid_data_models-0.0.1/.github/workflows/main_test.yaml

@@ -0,0 +1,39 @@
+name: Main - CI
+
+on:
+  schedule:
+  - cron: "0 0 * * 1-5"
+  push:
+    branches:
+      - main
+
+
+jobs:
+  test:
+    runs-on: ubuntu-latest
+    strategy:
+      matrix:
+        python-version: ["3.11"]
+
+    steps:
+      - uses: actions/checkout@v4
+      - name: Set up Python ${{ matrix.python-version }}
+        uses: actions/setup-python@v5
+        with:
+          python-version: ${{ matrix.python-version }}
+      - name: Install dependencies
+        run: |
+          python -m pip install --upgrade pip
+          python -m pip install ".[dev]"
+      - name: Run pytest
+        run: |
+          python -m pytest -v --disable-warnings tests
+  ruff:
+    runs-on: ubuntu-latest
+    name: "ruff"
+    steps:
+      - uses: davidslusser/actions_python_ruff@v1.0.0
+        with:
+          src: "src"
+          pip_install_command: "pip install -e .[dev]"
+          python_version: "3.11"

grid_data_models-0.0.1/.github/workflows/publish_to_pypi.yaml

@@ -0,0 +1,27 @@
+name: Upload to PyPi
+
+on:
+  release:
+    types: [published]
+
+jobs:
+  deploy:
+    runs-on: ubuntu-latest
+    steps:
+    - uses: actions/checkout@v4
+    - name: Set up Python
+      uses: actions/setup-python@v5
+      with:
+        python-version: 3.11
+    - name: Install dependencies
+      run: |
+        python -m pip install --upgrade pip
+        python -m pip install build
+        pip install setuptools wheel twine
+    - name: Build and publish
+      env:
+        TWINE_USERNAME: ${{ secrets.PYPI_USERNAME }}
+        TWINE_PASSWORD: ${{ secrets.PYPI_TOKEN }}
+      run: |
+        python -m build
+        twine upload dist/*

grid_data_models-0.0.1/.github/workflows/pull_request_tests.yml

@@ -0,0 +1,33 @@
+name: Pytest
+
+on: pull_request
+
+jobs:
+  test:
+    runs-on: ubuntu-latest
+    strategy:
+      matrix:
+        python-version: ["3.11"]
+
+    steps:
+      - uses: actions/checkout@v4
+      - name: Set up Python ${{ matrix.python-version }}
+        uses: actions/setup-python@v5
+        with:
+          python-version: ${{ matrix.python-version }}
+      - name: Install dependencies
+        run: |
+          python -m pip install --upgrade pip
+          python -m pip install ".[dev]"
+      - name: Run pytest
+        run: |
+          python -m pytest -v --disable-warnings tests
+  ruff:
+    runs-on: ubuntu-latest
+    name: "ruff"
+    steps:
+      - uses: davidslusser/actions_python_ruff@v1.0.0
+        with:
+          src: "src"
+          pip_install_command: "pip install -e .[dev]"
+          python_version: "3.11"

grid_data_models-0.0.1/.gitignore

@@ -0,0 +1,163 @@
+# Byte-compiled / optimized / DLL files
+__pycache__/
+*.py[cod]
+*$py.class
+
+# C extensions
+*.so
+*.code-workspace
+*.sqlite
+*.ruff_cache/
+
+# 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/
+
+# 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/

grid_data_models-0.0.1/.pre-commit-config.yaml

@@ -0,0 +1,10 @@
+repos:
+  - repo: https://github.com/astral-sh/ruff-pre-commit
+    # Ruff version.
+    rev: v0.1.8
+    hooks:
+      # Run the linter.
+      - id: ruff
+        args: [--fix]
+      # Run the formatter.
+      - id: ruff-format

grid_data_models-0.0.1/LICENSE.txt

@@ -0,0 +1,29 @@
+BSD 3-Clause License
+
+Copyright (c) 2024, Alliance for Sustainable Energy, LLC
+All rights reserved.
+
+Redistribution and use in source and binary forms, with or without
+modification, are permitted provided that the following conditions are met:
+
+1. Redistributions of source code must retain the above copyright notice, this
+   list of conditions and the following disclaimer.
+
+2. Redistributions in binary form must reproduce the above copyright notice,
+   this list of conditions and the following disclaimer in the documentation
+   and/or other materials provided with the distribution.
+
+3. Neither the name of the copyright holder nor the names of its
+   contributors may be used to endorse or promote products derived from
+   this software without specific prior written permission.
+
+THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
+AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
+IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
+DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE
+FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
+DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR
+SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER
+CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
+OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
+OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.

grid_data_models-0.0.1/PKG-INFO

@@ -0,0 +1,54 @@
+Metadata-Version: 2.3
+Name: grid-data-models
+Version: 0.0.1
+Project-URL: Documentation, https://github.com/NREL-Distribution-Suites/grid-data-models#readme
+Project-URL: Issues, https://github.com/NREL-Distribution-Suites/grid-data-models/issues
+Project-URL: Source, https://github.com/NREL-Distribution-Suites/grid-data-models
+Author-email: Kapil Duwadi <Kapil.Duwadi@nrel.gov>, Aadil Latif <Aadil.Latif@nrel.gov>, Tarek Elgindy <tarek.elgindy@nrel.gov>
+License-Expression: BSD-3-Clause
+License-File: LICENSE.txt
+Classifier: License :: OSI Approved :: BSD License
+Classifier: Operating System :: OS Independent
+Classifier: Programming Language :: Python :: 3.11
+Requires-Python: >=3.11
+Requires-Dist: infrasys
+Requires-Dist: networkx
+Provides-Extra: dev
+Requires-Dist: pre-commit; extra == 'dev'
+Requires-Dist: pytest; extra == 'dev'
+Requires-Dist: pytest-cov; extra == 'dev'
+Requires-Dist: ruff; extra == 'dev'
+Provides-Extra: doc
+Requires-Dist: myst-parser; extra == 'doc'
+Requires-Dist: sphinx; extra == 'doc'
+Requires-Dist: sphinx-immaterial; extra == 'doc'
+Requires-Dist: sphinxcontrib-mermaid; extra == 'doc'
+Description-Content-Type: text/markdown
+
+# Grid Data Models (GDM)
+
+GDM is a python package containing [pydantic](https://docs.pydantic.dev/latest/) data models for power system assets and datasets. This package is actively being developed at [National Renewable Energy Laboratory (NREL)](https://www.nrel.gov/).
+
+## Why Grid Data Models ?
+
+In an effort to reduce code duplication and provide client packages a standard interface to interact with power system data, a group of 
+research engineers at NREL is working on developing standard data models. Features:
+
+- **Builtin validation layer:** Use of [pydantic](https://docs.pydantic.dev/latest/) in creating data models allows us to check for fields during the time of construction and update.
+- **Timeseries data management:** GDM uses [infrasys](https://github.nrel.gov/CADET/infrastructure_systems) package which enables attaching time series data to fields in the data model. For example, we can attach time series power consumption data to a load profile.
+- **Builtin unit conversion:** GDM leverages [pint](https://pint.readthedocs.io/en/stable/) for unit conversion for power system quantities. For e.g power, voltage, time etc.
+- **JSON serialization/deserializatin:** GDM uses [infrasys](https://github.nrel.gov/CADET/infrastructure_systems) to serialize and deserialize distribution system containing power system components and time series data attached to components.
+
+## How to get started ?
+
+To get started, you can clone and pip install this library from [here](https://github.nrel.gov/CADET/grid-data-models).
+
+
+## Contributors
+
+- **Kapil Duwadi**
+- **Tarek Elgindy**
+- **Aadil Latif**
+- **Pedro Andres Sanchez Perez**
+- **Daniel Thompson**
+- **Jeremy Keen**

grid_data_models-0.0.1/README.md

@@ -0,0 +1,27 @@
+# Grid Data Models (GDM)
+
+GDM is a python package containing [pydantic](https://docs.pydantic.dev/latest/) data models for power system assets and datasets. This package is actively being developed at [National Renewable Energy Laboratory (NREL)](https://www.nrel.gov/).
+
+## Why Grid Data Models ?
+
+In an effort to reduce code duplication and provide client packages a standard interface to interact with power system data, a group of 
+research engineers at NREL is working on developing standard data models. Features:
+
+- **Builtin validation layer:** Use of [pydantic](https://docs.pydantic.dev/latest/) in creating data models allows us to check for fields during the time of construction and update.
+- **Timeseries data management:** GDM uses [infrasys](https://github.nrel.gov/CADET/infrastructure_systems) package which enables attaching time series data to fields in the data model. For example, we can attach time series power consumption data to a load profile.
+- **Builtin unit conversion:** GDM leverages [pint](https://pint.readthedocs.io/en/stable/) for unit conversion for power system quantities. For e.g power, voltage, time etc.
+- **JSON serialization/deserializatin:** GDM uses [infrasys](https://github.nrel.gov/CADET/infrastructure_systems) to serialize and deserialize distribution system containing power system components and time series data attached to components.
+
+## How to get started ?
+
+To get started, you can clone and pip install this library from [here](https://github.nrel.gov/CADET/grid-data-models).
+
+
+## Contributors
+
+- **Kapil Duwadi**
+- **Tarek Elgindy**
+- **Aadil Latif**
+- **Pedro Andres Sanchez Perez**
+- **Daniel Thompson**
+- **Jeremy Keen**

grid_data_models-0.0.1/docs/Makefile

@@ -0,0 +1,20 @@
+# Minimal makefile for Sphinx documentation
+#
+
+# You can set these variables from the command line, and also
+# from the environment for the first two.
+SPHINXOPTS    ?=
+SPHINXBUILD   ?= sphinx-build
+SOURCEDIR     = .
+BUILDDIR      = _build
+
+# Put it first so that "make" without argument is like "make help".
+help:
+	@$(SPHINXBUILD) -M help "$(SOURCEDIR)" "$(BUILDDIR)" $(SPHINXOPTS) $(O)
+
+.PHONY: help Makefile
+
+# Catch-all target: route all unknown targets to Sphinx using the new
+# "make mode" option.  $(O) is meant as a shortcut for $(SPHINXOPTS).
+%: Makefile
+	@$(SPHINXBUILD) -M $@ "$(SOURCEDIR)" "$(BUILDDIR)" $(SPHINXOPTS) $(O)

grid_data_models-0.0.1/docs/api/distribution_branch.md

@@ -0,0 +1,9 @@
+# Distribution Branch
+
+
+```{eval-rst}
+.. automodule:: gdm
+    :members: SequenceImpedanceBranchEquipment, MatrixImpedanceBranchEquipment, GeometryBranchEquipment, DistributionBranch, MatrixImpedanceBranch, GeometryBranch
+    :exclude-members: model_fields, model_config, validate_fields
+
+```

grid_data_models-0.0.1/docs/api/distribution_bus.md

@@ -0,0 +1,9 @@
+# Distribution Bus
+
+
+```{eval-rst}
+.. autoclass:: gdm.DistributionBus
+    :members:
+    :exclude-members: model_fields, model_config
+
+```

grid_data_models-0.0.1/docs/api/distribution_capacitor.md

@@ -0,0 +1,9 @@
+# Distribution Capacitor
+
+
+```{eval-rst}
+.. automodule:: gdm
+    :members: DistributionCapacitor, PhaseCapacitorEquipment, CapacitorEquipment
+    :exclude-members: model_fields, model_config, validate_fields
+
+```

grid_data_models-0.0.1/docs/api/distribution_component.md

@@ -0,0 +1,9 @@
+# Distribution Component
+
+
+```{eval-rst}
+.. automodule:: gdm
+    :members: DistributionComponent
+    :exclude-members: model_fields, model_config, validate_fields
+
+```

grid_data_models-0.0.1/docs/api/distribution_enum.md

@@ -0,0 +1,8 @@
+# Distribution Enumerations
+
+
+```{eval-rst}
+.. automodule:: gdm
+    :members: Phase, ConnectionType, VoltageTypes, LimitType
+
+```

grid_data_models-0.0.1/docs/api/distribution_feeder.md

@@ -0,0 +1,8 @@
+# Distribution Feeder
+
+
+```{eval-rst}
+.. automodule:: gdm
+    :members: DistributionFeeder
+
+```

grid_data_models-0.0.1/docs/api/distribution_load.md

@@ -0,0 +1,9 @@
+# Distribution Load
+
+
+```{eval-rst}
+.. automodule:: gdm
+    :members: DistributionLoad, LoadEquipment, PhaseLoadEquipment
+    :exclude-members: model_fields, model_config, validate_fields
+
+```

grid_data_models-0.0.1/docs/api/distribution_substation.md

@@ -0,0 +1,8 @@
+# Distribution Substation
+
+
+```{eval-rst}
+.. automodule:: gdm
+    :members: DistributionSubstation
+
+```

grid_data_models-0.0.1/docs/api/distribution_transformer.md

@@ -0,0 +1,9 @@
+# Distribution Transformer
+
+
+```{eval-rst}
+.. automodule:: gdm
+    :members: WindingEquipment, TapWindingEquipment, DistributionTransformerEquipment, DistributionTransformer
+    :exclude-members: model_fields, model_config, validate_fields
+
+```

grid_data_models-0.0.1/docs/api/distribution_transformer_equipment.md

@@ -0,0 +1,9 @@
+# Distribution Transformer Equipment
+
+
+```{eval-rst}
+.. automodule:: gdm
+    :members: WindingEquipment, TapWindingEquipment, DistributionTransformerEquipment
+    :exclude-members: model_fields, model_config, validate_fields
+
+```

grid_data_models-0.0.1/docs/api/distribution_vsource.md

@@ -0,0 +1,9 @@
+# Distribution Voltage Sources
+
+
+```{eval-rst}
+.. automodule:: gdm
+    :members: PhaseVoltageSourceEquipment, VoltageSourceEquipment, DistributionVoltageSource
+    :exclude-members: model_fields, model_config
+
+```

grid_data_models-0.0.1/docs/api/distribution_wires.md

@@ -0,0 +1,9 @@
+# Distribution Wires
+
+
+```{eval-rst}
+.. automodule:: gdm
+    :members: BareConductorEquipment, ConcentricCableEquipment
+    :exclude-members: model_fields, model_config
+
+```

grid_data_models-0.0.1/docs/api/limitset.md

@@ -0,0 +1,9 @@
+# Distribution Limitsets
+
+
+```{eval-rst}
+.. automodule:: gdm
+    :members: VoltageLimitSet, ThermalLimitSet
+    :exclude-members: model_fields, model_config
+
+```

grid_data_models-0.0.1/docs/api/quantities.md

@@ -0,0 +1,8 @@
+# Quantities
+
+
+```{eval-rst}
+.. automodule:: gdm.quantities
+    :members: 
+
+```

grid_data_models-0.0.1/docs/cim/distribution-bus.md

@@ -0,0 +1,86 @@
+# Terminal in CIM vs DistributionBus in GDM
+
+Figure below shows an UML diagram for `Terminal` and `ConnectivityNode` in Common Information Model (CIM) which is used to connect terminals of 
+ac conducting equipment which is analogous to `DistributionBus` in grid data models. [The CIM diagram is accessed from here.](https://ontology.tno.nl/IEC_CIM/cim_Terminal.html). `Terminal` class inherits from `IdentifiedObject` class which has `name`, `description` and `mrid`. `IdentifiedObject.mrid` is analogous to `ComponentWithQuantities.uuid`. Note in GDM we also have `system_uuid` to sort of manage which system these assets belong to. Also `DistributionBus` has `coordinate` attribute of type `Location` which is equivalent to `PositionPoint` in CIM. 
+
+
+| GDM | CIM | Note |
+|-----|-----|------|
+|`ComponentWithQuantities.name`| `cim:IdentifiedObject.name`| Both of them are string. |
+| `ComponentWithQuantities.uuid` | `cim:IdentifiedObject.mrid` | Unique identifier for the component. |
+| `ComponentWithQuantities.system_uuid` | N/A | System UUID to which this component belongs to. |
+| `PowerSystemBus.nominal_voltage` | `cim:BaseVoltage.nominalVoltage` | Note nominal voltage is unit aware but BaseVoltage is not. |
+| `Location.x` | `cim:PositionPoint.xPosition` | x coordinate of the component. |
+| `Location.y` | `cim:PositionPoint.yPosition` | y coordinate of the component |
+| `Location.crs` | N/A | Coordinate reference system for geo coordinates. |
+| `DistributionBus.voltage_type` | N/A | Differentiates from line to line voltage to line to ground voltage |
+| `DistributionComponent.feeder` |  | Name of the feeder to which this component belong to|
+| `DistributionComponent.substation` |  | Name of the substation to which this component belongs to. |
+| `DistributionBus.phases` | `cim:Terminal.phases`| List of phases.| 
+| `VoltageLimitSet.type` | | Limit type min or max |
+| `VoltageLimitSet.value` | | Value for limit. |
+
+![Connectivity Node](./cim-connectivity-node.PNG)
+
+Here is an UML diagram of `DistributionBus` from Grid data models.
+
+```{mermaid}
+
+    classDiagram
+
+      class ComponentWithQuantities
+      ComponentWithQuantities: +name str 
+      ComponentWithQuantities: +uuid UUID
+      ComponentWithQuantities: +system_uuid UUID | None
+
+      class PowerSystemBus
+      PowerSystemBus: +nominal_voltage PositiveVoltage
+      PowerSystemBus: +coordinate Location | None
+
+      class Location
+      Location: +x float
+      Location: +y float 
+      Location: +crs str | None
+
+      class DistributionBus
+      DistributionBus: +voltage_type VoltageTypes
+      DistributionBus: +belongs_to DistributionComponent | None 
+      DistributionBus: +phases list[Phase]
+      DistributionBus: +voltagelimits list[VoltageLimitSet]
+
+      class VoltageTypes{
+        <<enumeration>>
+        LINE_TO_LINE
+        LINE_TO_GROUND
+      }
+
+      class DistributionComponent
+      DistributionComponent: +feeder str
+      DistributionComponent: +substation str
+
+      class Phase{
+        <<enumeration>>
+        A
+        B
+        C
+        N
+        s1
+        s2
+      }
+
+      class VoltageLimitSet
+      VoltageLimitSet: +limit_type LimitType
+      VoltageLimitSet: +value PositiveVoltage
+
+      class LimitType{
+        <<enumerations>>
+        MIN
+        MAX
+      }
+
+      PowerSystemBus --|> ComponentWithQuantities
+      Location --* PowerSystemBus
+      DistributionBus --|> PowerSystemBus
+      DistributionComponent <-- DistributionBus
+      VoltageLimitSet "0..*" --> "1" DistributionBus
+```