michael-sankur / gigpower Goto Github PK

Sphinx's autodoc extension can use napoleon to render numpy doc strings in a nice way. Re-write doc strings to follow numpy conventions:https://sphinxcontrib-napoleon.readthedocs.io/en/latest/example_numpy.html

Many objects have attributes that are not preceded by underscores, therefore by convention, they are considered to be public. It would be better practice to make all attributes private, and provide getters and setter methods for users to explicitly read and change attributes. Here is a general example of how to revise:

Before: attributes set on the object without getters/setters:

class Solution

  def __init__(dss_file, **kwargs):
    self.V = None

After: prepend all attributes with underscores and provide getters and setters as appropriate:

class Solution

  def __init__(dss_file, **kwargs):
    self._V = None

  def get_V(self):
    return self._V

  def set_V(self):
    raise Error("Cannot set Solution voltages.")

Circuits and Solutions are complicated objects! A diagram would make relationships much clearer.

Remove all calls to dss objects from Solution, SolutionNR3, and SolutionFBS objects. That way they are fully insulated from opendss and only reflect what's going on in the Circuit objects.

See https://github.com/elaguerta/gigpower/releases/tag/0.1.0 for older code that can be used as a model.