NREL-pypsse 1.0.0a0__tar.gz

nrel_pypsse-1.0.0a0/.gitignore

@@ -0,0 +1,160 @@
+
+# Created by https://www.toptal.com/developers/gitignore/api/python
+# Edit at https://www.toptal.com/developers/gitignore?templates=python
+
+### Python ###
+# Byte-compiled / optimized / DLL files
+__pycache__/
+*.py[cod]
+*$py.class
+*.svg
+# C extensions
+*.so
+*$hdf5
+
+# Distribution / packaging
+.Python
+reports/
+project/
+build/
+develop-eggs/
+dist/
+downloads/
+eggs/
+.eggs/
+parts/
+sdist/
+var/
+wheels/
+pip-wheel-metadata/
+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/
+pytestdebug.log
+
+# Translations
+*.mo
+*.pot
+
+*.tar.gz
+*.whl
+
+# Django stuff:
+*.log
+local_settings.py
+db.sqlite3
+db.sqlite3-journal
+
+# Flask stuff:
+instance/
+.webassets-cache
+
+# Scrapy stuff:
+.scrapy
+
+# Sphinx documentation
+docs/_build/
+doc/_build/
+
+# PyBuilder
+target/
+
+# Jupyter Notebook
+.ipynb_checkpoints
+
+# IPython
+profile_default/
+ipython_config.py
+
+# pyenv
+.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
+#poetry.lock
+
+# PEP 582; used by e.g. github.com/David-OConnor/pyflow
+__pypackages__/
+
+# Celery stuff
+celerybeat-schedule
+celerybeat.pid
+
+# SageMath parsed files
+*.sage.py
+
+# Environments
+# .env
+.env/
+.venv/
+env/
+venv/
+ENV/
+env.bak/
+venv.bak/
+pythonenv*
+
+# 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/
+
+# operating system-related files
+# file properties cache/storage on macOS
+*.DS_Store
+# thumbnail cache on Windows
+Thumbs.db
+
+# profiling data
+.prof
+
+
+# End of https://www.toptal.com/developers/gitignore/api/python

nrel_pypsse-1.0.0a0/LICENSE

@@ -0,0 +1,13 @@
+BSD 3-Clause License
+
+Copyright (c) 2018, 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:
+
+- Redistributions of source code must retain the above copyright notice, this list of conditions and the following disclaimer.
+
+- 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.
+
+- 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.

nrel_pypsse-1.0.0a0/PKG-INFO

@@ -0,0 +1,64 @@
+Metadata-Version: 2.1
+Name: NREL-pypsse
+Version: 1.0.0a0
+Summary: A high-level python interface for PSS/E
+Project-URL: Homepage, http://www.github.com/nrel/pypsse
+Author-email: Aadil Latif <Aadil.Latif@nrel.gov>
+License-Expression: BSD-3-Clause
+License-File: LICENSE
+Classifier: Development Status :: 4 - Beta
+Classifier: Environment :: Console
+Classifier: Environment :: Web Environment
+Classifier: Intended Audience :: Developers
+Classifier: Intended Audience :: Science/Research
+Classifier: License :: OSI Approved :: BSD License
+Classifier: Operating System :: OS Independent
+Classifier: Programming Language :: Python :: 3
+Requires-Python: >=3.8
+Requires-Dist: click
+Requires-Dist: h5py
+Requires-Dist: helics
+Requires-Dist: networkx
+Requires-Dist: numpy
+Requires-Dist: pandas
+Requires-Dist: pydantic~=2.4
+Requires-Dist: pyyaml
+Requires-Dist: requests
+Requires-Dist: terminaltables
+Requires-Dist: toml
+Requires-Dist: xlrd
+Provides-Extra: dev
+Requires-Dist: black; extra == 'dev'
+Requires-Dist: mypy; extra == 'dev'
+Requires-Dist: pylint; extra == 'dev'
+Provides-Extra: doc
+Requires-Dist: erdantic; extra == 'doc'
+Requires-Dist: mdutils; extra == 'doc'
+Requires-Dist: mkdocs; extra == 'doc'
+Requires-Dist: mkdocs-click; extra == 'doc'
+Requires-Dist: mkdocs-glightbox; extra == 'doc'
+Requires-Dist: mkdocs-material; extra == 'doc'
+Requires-Dist: mkdocs-table-reader-plugin; extra == 'doc'
+Requires-Dist: mkdocs-video; extra == 'doc'
+Requires-Dist: mkdocstrings[python]; extra == 'doc'
+Requires-Dist: neoteroi-mkdocs; extra == 'doc'
+Requires-Dist: pygraphviz; extra == 'doc'
+Provides-Extra: server
+Requires-Dist: fastapi; extra == 'server'
+Requires-Dist: python-multipart; extra == 'server'
+Requires-Dist: uvicorn[standard]; extra == 'server'
+Requires-Dist: websockets; extra == 'server'
+Description-Content-Type: text/markdown
+
+## :blush: Welcome to the PyPSSE Repository
+
+> A python wrapper around psspy (python API for PSSE simulator) to perform
+> time series powerflow and dynamic simulation for power system fault
+
+### :email: Contact Information
+* :snowman: [Aadil Latif](mailto:aadil.latif@nrel.gov)
+* :snowman: [Kapil Duwadi](mailto:kapil.duwadi@nrel.gov)
+
+###
+
+For usage guidance, pleae see [PyPSSE documentation](https://NREL.github.io/PyPSSE/)

nrel_pypsse-1.0.0a0/README.md

@@ -0,0 +1,12 @@
+## :blush: Welcome to the PyPSSE Repository
+
+> A python wrapper around psspy (python API for PSSE simulator) to perform
+> time series powerflow and dynamic simulation for power system fault
+
+### :email: Contact Information
+* :snowman: [Aadil Latif](mailto:aadil.latif@nrel.gov)
+* :snowman: [Kapil Duwadi](mailto:kapil.duwadi@nrel.gov)
+
+###
+
+For usage guidance, pleae see [PyPSSE documentation](https://NREL.github.io/PyPSSE/)

nrel_pypsse-1.0.0a0/pyproject.toml

@@ -0,0 +1,181 @@
+[build-system]
+requires = ["hatchling"]
+build-backend = "hatchling.build"
+
+[project]
+name = "NREL-pypsse"
+dynamic = ["version"]
+description = "A high-level python interface for PSS/E"
+readme = "README.md"
+license = "BSD-3-Clause"
+requires-python = ">=3.8"
+
+authors = [
+    { name = "Aadil Latif", email = "Aadil.Latif@nrel.gov" },
+]
+classifiers = [
+    "Development Status :: 4 - Beta",
+    "Environment :: Console",
+    "Environment :: Web Environment",
+    "Intended Audience :: Developers",
+    "Intended Audience :: Science/Research",
+    "License :: OSI Approved :: BSD License",
+    "Operating System :: OS Independent",
+    "Programming Language :: Python :: 3",
+]
+dependencies = [
+
+    "click",
+    "h5py",
+    "helics",
+    "networkx",
+    "numpy",
+    "pandas",
+    "pydantic~=2.4",
+    "PyYAML",
+    "requests",
+    "terminaltables",
+    "toml",
+    "xlrd"
+]
+
+[project.scripts]
+pypsse = "pypsse.cli.pypsse:cli"
+
+[project.urls]
+Homepage = "http://www.github.com/nrel/pypsse"
+
+[tool.hatch.version]
+path = "pypsse/__init__.py"
+
+[tool.hatch.envs.test]
+dependencies = [
+  "coverage[toml]",
+  "pytest",
+  "pytest-cov",
+  "pytest-mock",
+]
+
+[tool.hatch.build.targets.sdist]
+include = [
+    "/pypsse",
+]
+
+[tool.hatch.build.targets.wheel]
+packages = [
+    "pypsse"
+]
+
+[project.optional-dependencies]
+doc = [
+  "mkdocs",
+  "mkdocs-material",
+  "mkdocstrings[python]",
+  "pygraphviz",
+  "erdantic",
+  "mdutils",
+  "mkdocs-glightbox",
+  "mkdocs-click",
+  "mkdocs-table-reader-plugin",
+  "mkdocs-video",
+  "neoteroi-mkdocs",
+]
+dev = [
+  "pylint",
+  "mypy",
+  "black"
+]
+server = [
+  "uvicorn[standard]",
+  "fastapi",
+  "websockets",
+  "python-multipart"
+]
+
+[tool.hatch.envs.lint]
+detached = true
+dependencies = [
+  "black>=23.1.0",
+  "mypy>=1.0.0",
+  "ruff>=0.0.243",
+]
+
+
+
+[tool.hatch.envs.lint.scripts]
+typing = "mypy --install-types --non-interactive {args:src/autogradinglean tests}"
+style = [
+  "ruff {args:.}",
+  "black --check --diff {args:.}",
+]
+fmt = [
+  "black {args:.}",
+  "ruff --fix {args:.}",
+  "style",
+]
+all = [
+  "style",
+  "typing",
+]
+
+[tool.black]
+target-version = ["py37"]
+line-length = 120
+skip-string-normalization = true
+
+[tool.ruff]
+target-version = "py37"
+line-length = 120
+select = [
+  "A",
+  "ARG",
+  "B",
+  "C",
+  "DTZ",
+  "E",
+  "EM",
+  "F",
+  "FBT",
+  "I",
+  "ICN",
+  "ISC",
+  "N",
+  "PLC",
+  "PLE",
+  "PLR",
+  "PLW",
+  "Q",
+  "RUF",
+  "S",
+  "T",
+  "TID",
+  "UP",
+  "W",
+  "YTT",
+]
+ignore = [
+  # Allow non-abstract empty methods in abstract base classes
+  "B027",
+  # Allow boolean positional values in function calls, like `dict.get(... True)`
+  "FBT003",
+  # Ignore checks for possible passwords
+  "S101", "S105", "S106", "S107", "RUF012", "PLR5501",
+  # Ignore complexity
+  "C901", "PLR0911", "PLR0912", "PLR0913", "PLR0915",
+  "N805", "B006", "FBT002"
+
+]
+unfixable = [
+  # Don't touch unused imports
+  "F401",
+]
+
+[tool.ruff.isort]
+known-first-party = ["autogradinglean"]
+
+[tool.ruff.flake8-tidy-imports]
+ban-relative-imports = "all"
+
+[tool.ruff.per-file-ignores]
+# Tests can use magic values, assertions, and relative imports
+"tests/**/*" = ["PLR2004", "S101", "TID252"]

nrel_pypsse-1.0.0a0/pypsse/__init__.py

@@ -0,0 +1 @@
+__version__ = "1.0.0-alpha"