initial commit

README.rst

@@ -0,0 +1,50 @@
+============
+grg-psse2grg
+============
+
+**release:**
+
+.. image:: https://badge.fury.io/py/grg-psse2grg.svg
+    :target: https://badge.fury.io/py/grg-psse2grg
+
+.. image:: https://readthedocs.org/projects/grg-psse2grg/badge/?version=stable
+  :target: http://grg-psse2grg.readthedocs.io/en/stable/?badge=stable
+  :alt: Documentation Status
+
+**dev status:**
+
+.. image:: https://travis-ci.org/lanl-ansi/grg-psse2grg.svg?branch=master
+  :target: https://travis-ci.org/lanl-ansi/grg-psse2grg
+  :alt: Build Report
+.. image:: https://codecov.io/gh/lanl-ansi/grg-psse2grg/branch/master/graph/badge.svg
+  :target: https://codecov.io/gh/lanl-ansi/grg-psse2grg
+  :alt: Coverage Report
+.. image:: https://readthedocs.org/projects/grg-psse2grg/badge/?version=latest
+  :target: http://grg-psse2grg.readthedocs.io/en/latest/?badge=latest
+  :alt: Documentation Status
+
+
+grg-psse2grg is a python package for translating between with PSSE and GRG data files.
+
+The package can be installed via::
+
+    pip install grg-psse2grg
+
+
+License
+------------
+This package is developed at Los Alamos National Laboratory and is provided under a BSD-3 license as part of the Grid Research for Good Software Tools (C18036), see the `LICENSE` file for the full text.
+
+
+Changelog
+------------
+
+**staged**
+
+- nothing
+
+
+**v0.0.1**
+
+- Initial test tag
+

docs/.gitignore

@@ -0,0 +1,4 @@
+_build
+_static
+_templates
+

docs/Makefile

@@ -0,0 +1,20 @@
+# Minimal makefile for Sphinx documentation
+#
+
+# You can set these variables from the command line.
+SPHINXOPTS    =
+SPHINXBUILD   = sphinx-build
+SPHINXPROJ    = grg-psse2grg
+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)

docs/conf.py

@@ -0,0 +1,161 @@
+#!/usr/bin/env python3
+# -*- coding: utf-8 -*-
+#
+# grg-psse2grg documentation build configuration file, created by
+# sphinx-quickstart on Sat Sep 22 23:09:00 2018.
+#
+# This file is execfile()d with the current directory set to its
+# containing dir.
+#
+# Note that not all possible configuration values are present in this
+# autogenerated file.
+#
+# All configuration values have a default; values that are commented out
+# serve to show the default.
+
+# If extensions (or modules to document with autodoc) are in another directory,
+# add these directories to sys.path here. If the directory is relative to the
+# documentation root, use os.path.abspath to make it absolute, like shown here.
+#
+# import os
+# import sys
+# sys.path.insert(0, os.path.abspath('.'))
+
+
+# -- General configuration ------------------------------------------------
+
+# If your documentation needs a minimal Sphinx version, state it here.
+#
+# needs_sphinx = '1.0'
+
+# Add any Sphinx extension module names here, as strings. They can be
+# extensions coming with Sphinx (named 'sphinx.ext.*') or your custom
+# ones.
+extensions = ['sphinx.ext.autodoc', 'sphinx.ext.mathjax']
+
+# Add any paths that contain templates here, relative to this directory.
+templates_path = ['_templates']
+
+# The suffix(es) of source filenames.
+# You can specify multiple suffix as a list of string:
+#
+# source_suffix = ['.rst', '.md']
+source_suffix = '.rst'
+
+# The master toctree document.
+master_doc = 'index'
+
+# General information about the project.
+project = 'grg-psse2grg'
+copyright = '2018, Carleton Coffrin'
+author = 'Carleton Coffrin'
+
+# The version info for the project you're documenting, acts as replacement for
+# |version| and |release|, also used in various other places throughout the
+# built documents.
+#
+# The short X.Y version.
+version = ''
+# The full version, including alpha/beta/rc tags.
+release = ''
+
+import grg_psse2grg
+release = grg_psse2grg.__version__
+version = 'v'+'.'.join(release.split('-')[0].split('.')[:3])
+
+# The language for content autogenerated by Sphinx. Refer to documentation
+# for a list of supported languages.
+#
+# This is also used if you do content translation via gettext catalogs.
+# Usually you set "language" from the command line for these cases.
+language = None
+
+# List of patterns, relative to source directory, that match files and
+# directories to ignore when looking for source files.
+# This patterns also effect to html_static_path and html_extra_path
+exclude_patterns = ['_build', 'Thumbs.db', '.DS_Store']
+
+# The name of the Pygments (syntax highlighting) style to use.
+pygments_style = 'sphinx'
+
+# If true, `todo` and `todoList` produce output, else they produce nothing.
+todo_include_todos = False
+
+
+# -- Options for HTML output ----------------------------------------------
+
+# The theme to use for HTML and HTML Help pages.  See the documentation for
+# a list of builtin themes.
+#
+html_theme = 'sphinx_rtd_theme'
+
+# Theme options are theme-specific and customize the look and feel of a theme
+# further.  For a list of options available for each theme, see the
+# documentation.
+#
+# html_theme_options = {}
+
+# Add any paths that contain custom static files (such as style sheets) here,
+# relative to this directory. They are copied after the builtin static files,
+# so a file named "default.css" will overwrite the builtin "default.css".
+html_static_path = ['_static']
+
+
+# -- Options for HTMLHelp output ------------------------------------------
+
+# Output file base name for HTML help builder.
+htmlhelp_basename = 'grg-psse2grgdoc'
+
+
+# -- Options for LaTeX output ---------------------------------------------
+
+latex_elements = {
+    # The paper size ('letterpaper' or 'a4paper').
+    #
+    # 'papersize': 'letterpaper',
+
+    # The font size ('10pt', '11pt' or '12pt').
+    #
+    # 'pointsize': '10pt',
+
+    # Additional stuff for the LaTeX preamble.
+    #
+    # 'preamble': '',
+
+    # Latex figure (float) alignment
+    #
+    # 'figure_align': 'htbp',
+}
+
+# Grouping the document tree into LaTeX files. List of tuples
+# (source start file, target name, title,
+#  author, documentclass [howto, manual, or own class]).
+latex_documents = [
+    (master_doc, 'grg-psse2grg.tex', 'grg-psse2grg Documentation',
+     'Carleton Coffrin', 'manual'),
+]
+
+
+# -- Options for manual page output ---------------------------------------
+
+# One entry per manual page. List of tuples
+# (source start file, name, description, authors, manual section).
+man_pages = [
+    (master_doc, 'grg-psse2grg', 'grg-psse2grg Documentation',
+     [author], 1)
+]
+
+
+# -- Options for Texinfo output -------------------------------------------
+
+# Grouping the document tree into Texinfo files. List of tuples
+# (source start file, target name, title, author,
+#  dir menu entry, description, category)
+texinfo_documents = [
+    (master_doc, 'grg-psse2grg', 'grg-psse2grg Documentation',
+     author, 'grg-psse2grg', 'One line description of project.',
+     'Miscellaneous'),
+]
+
+
+

docs/grg_psse2grg.rst

@@ -0,0 +1,38 @@
+grg-psse2grg package
+====================
+
+.. Submodules
+.. ----------
+
+grg_psse2grg.io module
+-----------------------
+
+.. automodule:: grg_psse2grg.io
+    :members:
+    :undoc-members:
+    :show-inheritance:
+
+grg_psse2grg.exception module
+-----------------------------
+
+.. automodule:: grg_psse2grg.exception
+    :members:
+    :undoc-members:
+    :show-inheritance:
+
+grg_psse2grg.struct module
+--------------------------
+
+.. automodule:: grg_psse2grg.struct
+    :members:
+    :undoc-members:
+    :show-inheritance:
+
+
+Module contents
+---------------
+
+.. automodule:: grg_psse2grg
+    :members:
+    :undoc-members:
+    :show-inheritance:

docs/index.rst

@@ -0,0 +1,22 @@
+.. grg-psse2grg documentation master file, created by
+   sphinx-quickstart on Sat Sep 22 23:09:00 2018.
+   You can adapt this file completely to your liking, but it should at least
+   contain the root `toctree` directive.
+
+Welcome to grg-psse2grg's documentation!
+========================================
+
+.. toctree::
+   :maxdepth: 2
+   :caption: Contents:
+
+   introduction
+   grg_psse2grg
+
+
+Indices and tables
+==================
+
+* :ref:`genindex`
+* :ref:`modindex`
+* :ref:`search`

docs/introduction.rst

@@ -0,0 +1,32 @@
+============
+Introduction
+============
+
+Overview
+------------------------
+
+grg-psse2grg is a python package for translating PSSE and GRG network data files.
+
+The primary entry point of the library is :class:`grg_psse2grg.io` module, which contains the methods for bi-directional translation.
+
+
+Installation
+------------------------
+
+Simply run::
+
+    pip install grg-psse2grg
+
+
+Testing
+------------------------
+
+grg-psse2grg is designed to be a library that supports other software.  
+It is not immediately useful from the terminal.
+However, you can test the parsing functionality from the command line with:: 
+
+    python -m grg_psse2grg.io <path to Matpower or GRG case file>
+
+If this command is successful, you will see a translated plain text version of the translated network data printed to the terminal.
+
+

grg_psse2grg/__init__.py

@@ -0,0 +1,8 @@
+"""a package for converting psse data files to grg data files"""
+
+# import standard entry points to the code
+from grg_psse2grg import io
+from grg_pssedata import exception
+
+__version__ = '0.0.1'
+

grg_psse2grg/exception.py

@@ -0,0 +1,5 @@
+'''a collection of all grg_psse2grg exception classes'''
+
+class PSSE2GRGWarning(Warning):
+    '''root class for all PSSE2GRG Warnings'''
+    pass