Merge pull request #43 from jinningwang/doc

Doc

.codacy.yml

@@ -3,8 +3,10 @@ engines:
   flake8:
     enabled: true
 exclude_paths:
+  - "setup.py"
   - "versioneer.py"
   - "ams/pypower/**"
   - "ams/_version.py"
   - ".github/**"
   - "README.md"
+  - "tests/**"

.codecov.yml

@@ -13,5 +13,10 @@ cli:
       report_type: "xml"
 
 ignore:
+  - "setup.py"
+  - "versioneer.py"
+  - "ams/pypower/**"
   - "ams/_version.py"
-  - "ams/pypower/**"
+  - ".github/**"
+  - "README.md"
+  - "tests/**"

ams/routines/__init__.py

@@ -4,7 +4,7 @@
 
 from collections import OrderedDict
 from andes.utils.func import list_flatten
-from ams.routines.routine import RoutineModel  # NOQA
+from ams.routines.routine import RoutineBase  # NOQA
 
 all_routines = OrderedDict([
     ('dcpf', ['DCPF']),

ams/routines/dcopf.py

@@ -7,15 +7,15 @@
 from ams.core.param import RParam
 from ams.core.service import NumOp, NumOpDual
 
-from ams.routines.routine import RoutineModel
+from ams.routines.routine import RoutineBase
 
 from ams.opt.omodel import Var, Constraint, Objective
 
 
 logger = logging.getLogger(__name__)
 
 
-class DCOPF(RoutineModel):
+class DCOPF(RoutineBase):
     """
     DC optimal power flow (DCOPF).
 
@@ -24,7 +24,7 @@ class DCOPF(RoutineModel):
     """
 
     def __init__(self, system, config):
-        RoutineModel.__init__(self, system, config)
+        RoutineBase.__init__(self, system, config)
         self.info = 'DC Optimal Power Flow'
         self.type = 'DCED'
         # --- Data Section ---
@@ -224,7 +224,7 @@ def run(self, no_code=True, **kwargs):
         kwargs : keywords, optional
             Additional solver specific arguments. See CVXPY documentation for details.
         """
-        return RoutineModel.run(self, no_code=no_code, **kwargs)
+        return RoutineBase.run(self, no_code=no_code, **kwargs)
 
     def _post_solve(self):
         # --- post-solving calculations ---

ams/routines/dcpf.py

@@ -6,7 +6,7 @@
 from andes.shared import deg2rad
 from andes.utils.misc import elapsed
 
-from ams.routines.routine import RoutineModel
+from ams.routines.routine import RoutineBase
 from ams.opt.omodel import Var
 from ams.pypower import runpf
 from ams.pypower.core import ppoption
@@ -17,15 +17,15 @@
 logger = logging.getLogger(__name__)
 
 
-class DCPFlowBase(RoutineModel):
+class DCPFlowBase(RoutineBase):
     """
     Base class for power flow.
 
     Overload the ``solve``, ``unpack``, and ``run`` methods.
     """
 
     def __init__(self, system, config):
-        RoutineModel.__init__(self, system, config)
+        RoutineBase.__init__(self, system, config)
         self.info = 'DC Power Flow'
         self.type = 'PF'
 

ams/routines/routine.py

@@ -27,7 +27,7 @@
 logger = logging.getLogger(__name__)
 
 
-class RoutineModel:
+class RoutineBase:
     """
     Class to hold descriptive routine models and data mapping.
     """
@@ -507,7 +507,7 @@ def __setattr__(self, key, value):
         self._check_attribute(key, value)
         self._register_attribute(key, value)
 
-        super(RoutineModel, self).__setattr__(key, value)
+        super(RoutineBase, self).__setattr__(key, value)
 
     def _register_attribute(self, key, value):
         """

examples/ex8.ipynb

@@ -93,8 +93,8 @@
    "cell_type": "markdown",
    "metadata": {},
    "source": [
-    "In AMS, a `RoutineModel` collects the descriptive dispatch formulations.\n",
-    "`DCOPF`, `RTED`, etc, are the subclasses of `RoutineModel`."
+    "In AMS, a routine collects the descriptive dispatch formulations.\n",
+    "`DCOPF`, `RTED`, etc, are the subclasses of `RoutineBase`."
    ]
   },
   {

tests/test_andes.py

@@ -8,14 +8,12 @@
 import andes
 import ams
 
-from ams.interop.andes import build_group_table, to_andes, parse_addfile
+from ams.interop.andes import build_group_table, make_link_table, to_andes, parse_addfile
 
 
 class TestInteropBase(unittest.TestCase):
     """
     Tests for basic function of ANDES interface.
-
-    # TODO: add case that involve PVD1 or REGCV1
     """
     ad_cases = [
         'ieee14/ieee14_full.xlsx',
@@ -31,12 +29,16 @@ def setUp(self) -> None:
         Test setup.
         """
 
-    def test_build_group_table(self):
+    def test_basic_functions(self):
+        """
+        Test basic functions defined in ANDES Interop.
+        """
         for ad_case in self.ad_cases:
             sa = andes.load(andes.get_case(ad_case),
                             setup=True,
                             no_output=True,
                             default_config=True,)
+            # --- test build_group_table ---
             ssa_stg = build_group_table(adsys=sa,
                                         grp_name='StaticGen',
                                         param_name=['u', 'name', 'idx', 'bus'],
@@ -49,8 +51,19 @@ def test_build_group_table(self):
                                         mdl_name=[])
             self.assertEqual(ssa_gov.shape,
                              (sa.TurbineGov.n, 2))
+            # --- test make_link_table ---
+            link_table = make_link_table(adsys=sa)
+            stg_idx = [str(i) for i in sa.PV.idx.v + sa.Slack.idx.v]
+            self.assertSetEqual(set(stg_idx),
+                                set(link_table['stg_idx'].values))
+            bus_idx = [str(i) for i in sa.PV.bus.v + sa.Slack.bus.v]
+            self.assertSetEqual(set(bus_idx),
+                                set(link_table['bus_idx'].values))
 
     def test_convert(self):
+        """
+        Test conversion from AMS case to ANDES case.
+        """
         for ad_case, am_case in zip(self.ad_cases, self.am_cases):
             sp = ams.load(ams.get_case(am_case),
                           setup=True,
@@ -72,21 +85,61 @@ def test_convert(self):
             # set2 includes set1, ensure GENROU.gen are all in StaticGen.idx
             self.assertEqual(set1, set1 & set2)
 
+    def test_extra_dyn(self):
+        """
+        Test conversion when extra dynamic models exist.
+        """
+        sp = ams.load(ams.get_case('ieee14/ieee14_uced.xlsx'),
+                      setup=True,
+                      no_output=True,
+                      default_config=True,)
+        sa = to_andes(sp, setup=True, addfile=andes.get_case('ieee14/ieee14_full.xlsx'))
+
+        self.assertGreaterEqual(sa.PVD1.n, 0)
 
-class TestANDES(unittest.TestCase):
-    """
-    Tests for ANDES interface.
 
-    # TODO: add tests for ANDES interface functions.
+class TestDataExchange(unittest.TestCase):
+    """
+    Tests for data exchange between AMS and ANDES.
     """
-    cases = [
-        '5bus/pjm5bus_demo.xlsx',
-        'ieee14/ieee14_uced.xlsx',
-        'ieee39/ieee39_uced_esd1.xlsx',
-        'matpower/case118.m',
-    ]
 
     def setUp(self) -> None:
         """
         Test setup. This is executed before each test case.
         """
+        self.sp = ams.load(ams.get_case('ieee14/ieee14_uced.xlsx'),
+                           setup=True,
+                           no_output=True,
+                           default_config=True,)
+        self.sp.RTED.run(solver='ECOS')
+        self.sp.RTED.dc2ac()
+        self.stg_idx = self.sp.RTED.pg.get_idx()
+
+    def test_data_exchange(self):
+        """
+        Test data exchange between AMS and ANDES.
+        """
+        sa = to_andes(self.sp, setup=True,
+                      addfile=andes.get_case('ieee14/ieee14_full.xlsx'),
+                      no_output=True,
+                      default_config=True,)
+        # alleviate limiter
+        sa.TGOV1.set(src='VMAX', attr='v', idx=sa.TGOV1.idx.v, value=100*np.ones(sa.TGOV1.n))
+        sa.TGOV1.set(src='VMIN', attr='v', idx=sa.TGOV1.idx.v, value=np.zeros(sa.TGOV1.n))
+
+        # --- test before PFlow ---
+        self.sp.dyn.send(adsys=sa, routine='RTED')
+        p0 = sa.StaticGen.get(src='p0', attr='v', idx=self.stg_idx)
+        pg = self.sp.RTED.get(src='pg', attr='v', idx=self.stg_idx)
+        np.testing.assert_array_equal(p0, pg)
+
+        # --- test after TDS ---
+        self.assertFalse(self.sp.dyn.is_tds)
+        sa.PFlow.run()
+        sa.TDS.init()
+        self.assertTrue(self.sp.dyn.is_tds)
+
+        sa.TDS.config.tf = 1
+        sa.TDS.run()
+        self.sp.dyn.send(adsys=sa, routine='RTED')
+        self.sp.dyn.receive(adsys=sa, routine='RTED', no_update=False)

tests/test_case.py

@@ -141,6 +141,28 @@ def test_ieee14_raw_convert(self):
         os.remove(ss.files.dump)
         self.assertEqual(ss.exit_code, 0, "Exit code is not 0.")
 
+    def test_ieee14_raw2xlsx(self):
+        ss = ams.load(
+            get_case("ieee14/ieee14.raw"),
+            setup=True,
+            no_output=True,
+            default_config=True,
+        )
+        ams.io.xlsx.write(ss, "ieee14.xlsx")
+        self.assertTrue(os.path.exists("ieee14.xlsx"))
+        os.remove("ieee14.xlsx")
+
+    def test_ieee14_raw2json(self):
+        ss = ams.load(
+            get_case("ieee14/ieee14.raw"),
+            setup=True,
+            no_output=True,
+            default_config=True,
+        )
+        ams.io.json.write(ss, "ieee14.json")
+        self.assertTrue(os.path.exists("ieee14.json"))
+        os.remove("ieee14.json")
+
     def test_ieee14_raw2json_convert(self):
         ss = ams.run(
             get_case("ieee14/ieee14.raw"),