Adding automated testing capabilities (#20)

* fixed CI location

* update language to UTF-8 for CI test

* remove python version and update seabed tools to close file

* edit cable props names everywhere

* remove a bunch of dependencies

* Update test input file locs, remove printout

* removed plt.show() from example and pytest to run with github actions

Author: lsirkis

.github/CI_FAModel.yml .github/workflows/CI_FAModel.yml.github/CI_FAModel.yml renamed to .github/workflows/CI_FAModel.yml

@@ -29,6 +29,7 @@
 
 #%% Section 1: Project without RAFT
 print('Creating project without RAFT\n')
+print(os.getcwd())
 # create project object
 project = Project(file=ontology_file,raft=False)
 # create moorpy system of the array, include cables in the system
@@ -42,7 +43,7 @@
 #create project object, automatically create RAFT object (and automatically create moorpy system in the process!)
 project = Project(file=ontology_file,raft=True)
 # plot in 3d, use moorpy system for mooring and cables, use RAFT for platform, tower, and turbine visuals
-project.plot3d(fowt=True,draw_boundary=False,boundary_on_bath=False)
+project.plot3d(fowt=True,draw_boundary=False,boundary_on_bath=False,save=True)
 
 # get location of RAFT model (stored as array property in project class)
 model = project.array
@@ -111,7 +112,6 @@
 print('\nPristine line polyester nominal diameter just below surface: ',reg_line_d)
 print('Marine growth line polyester nominal diameter just below surface: ',mg_line_d)
 
-plt.show()
 
 
 

examples/example_driver.py

@@ -31,7 +31,7 @@ def loadCableProps(source):
     elif source is None or source=="default":
         import os
         dir = os.path.dirname(os.path.realpath(__file__))
-        with open(os.path.join(dir,"CableProps_default.yaml")) as file:
+        with open(os.path.join(dir,"cableProps_default.yaml")) as file:
             source = yaml.load(file, Loader=yaml.FullLoader)
 
     elif type(source) is str:
@@ -172,7 +172,7 @@ def loadBuoyProps(source):
     elif source is None or source=="default":
         import os
         dir = os.path.dirname(os.path.realpath(__file__))
-        with open(os.path.join(dir,"CableProps_default.yaml")) as file:
+        with open(os.path.join(dir,"cableProps_default.yaml")) as file:
             source = yaml.load(file, Loader=yaml.FullLoader)
 
     elif type(source) is str:
@@ -267,7 +267,7 @@ def getBuoyProps(V, buoy_type, buoyProps=None, source=None, name="", rho=1025.0,
 
 if __name__ == '__main__':
 
-    cableProps = loadCableProps('CableProps_default.yaml')
+    cableProps = loadCableProps('cableProps_default.yaml')
 
     As = [95,120, 150, 185, 200, 300, 400, 500, 630, 800]
 

famodel-env.yaml

@@ -12,33 +12,33 @@
 
 def readBathymetryFile(filename, dtype=float):
 
-    f = open(filename, 'r')
-    # skip the header
-    line = next(f)
-    # collect the number of grid values in the x and y directions from the second and third lines
-    line = next(f)
-    nGridX = int(line.split()[1])
-    line = next(f)
-    nGridY = int(line.split()[1])
-    # allocate the Xs, Ys, and main bathymetry grid arrays
-    bathGrid_Xs = np.zeros(nGridX)
-    bathGrid_Ys = np.zeros(nGridY)
-    bathGrid = np.zeros([nGridY, nGridX], dtype=dtype)  # MH swapped order June 30
-    # read in the fourth line to the Xs array
-    line = next(f)
-    bathGrid_Xs = [float(line.split()[i]) for i in range(nGridX)]
-    strlist = []
-    # read in the remaining lines in the file into the Ys array (first entry) and the main bathymetry grid
-    for i in range(nGridY):
+    with open(filename, 'r') as f:
+        # skip the header
+        line = next(f)
+        # collect the number of grid values in the x and y directions from the second and third lines
+        line = next(f)
+        nGridX = int(line.split()[1])
         line = next(f)
-        entries = line.split()
-        bathGrid_Ys[i] = entries[0]
-        if dtype==float:
-            bathGrid[i,:] = entries[1:]
+        nGridY = int(line.split()[1])
+        # allocate the Xs, Ys, and main bathymetry grid arrays
+        bathGrid_Xs = np.zeros(nGridX)
+        bathGrid_Ys = np.zeros(nGridY)
+        bathGrid = np.zeros([nGridY, nGridX], dtype=dtype)  # MH swapped order June 30
+        # read in the fourth line to the Xs array
+        line = next(f)
+        bathGrid_Xs = [float(line.split()[i]) for i in range(nGridX)]
+        strlist = []
+        # read in the remaining lines in the file into the Ys array (first entry) and the main bathymetry grid
+        for i in range(nGridY):
+            line = next(f)
+            entries = line.split()
+            bathGrid_Ys[i] = entries[0]
+            if dtype==float:
+                bathGrid[i,:] = entries[1:]
+            if dtype==str:
+                strlist.append(entries[1:])
         if dtype==str:
-            strlist.append(entries[1:])
-    if dtype==str:
-        bathGrid = np.array(strlist)
+            bathGrid = np.array(strlist)
 
     return bathGrid_Xs, bathGrid_Ys, bathGrid
 

famodel/cables/cable_properties.py

@@ -1,11 +1,13 @@
 # tests anchor capacity and load functionality
 from famodel.project import Project
 import numpy as np
+import os
 
 
 def test_anchor_loads():
     # load in famodel project 
-    project = Project(file='tests/testOntology.yaml', raft=False)
+    dir = os.path.dirname(os.path.realpath(__file__))
+    project = Project(file=os.path.join(dir,'testOntology.yaml'), raft=False)
     project.getMoorPyArray(cables=1)
     anch = project.anchorList['FOWT1a']
 
@@ -18,7 +20,8 @@ def test_anchor_loads():
 
 def test_anchor_capacities():
     # load in famodel project (suction pile anchor)
-    project = Project(file='tests/testOntology.yaml', raft=False)
+    dir = os.path.dirname(os.path.realpath(__file__))
+    project = Project(file=os.path.join(dir,'testOntology.yaml'), raft=False)
     project.getMoorPyArray(cables=1)
     anch = project.anchorList['FOWT1a']
 

famodel/seabed/seabed_tools.py

@@ -13,15 +13,19 @@
 
 from famodel.mooring.mooring import Mooring
 
+import os
+
 
 def test_MoorPy_integration():
-    project = Project(file='tests/testOntology.yaml',raft=0)
+    dir = os.path.dirname(os.path.realpath(__file__))
+    project = Project(file=os.path.join(dir,'testOntology.yaml'), raft=False)
     project.getMoorPyArray(cables=1,plt=1)
     # check a random mooring line for ss
     assert project.mooringList['FOWT1a'].ss is not None
 
 def test_RAFT_integration():
-    project = Project(file='tests/testOntology.yaml')
+    dir = os.path.dirname(os.path.realpath(__file__))
+    project = Project(file=os.path.join(dir,'testOntology.yaml'), raft=True)
     assert project.array is not None
 
 '''def test_FLORIS_integration():'''

tests/test_anchors.py

@@ -23,6 +23,8 @@
 from famodel.cables.components import Joint
 from famodel.turbine.turbine import Turbine
 
+import os
+
 """
 
 def test_tensions_swap():
@@ -52,7 +54,8 @@ def test_bathymetry():
     project = Project()
 
     # load bathymetry file (MoorDyn style)
-    project.loadBathymetry('tests/bathymetry_sample.txt')
+    dir = os.path.dirname(os.path.realpath(__file__))
+    project.loadBathymetry(os.path.join(dir,'bathymetry_sample.txt'))
 
     # sample the depth somewhere
     x=20
@@ -62,10 +65,10 @@ def test_bathymetry():
 
     # plot to see if it worked
     #project.plot3d()
-    plt.show()
 
 def test_create_components():
-    project = Project(file='tests/testOntology.yaml',raft=0)
+    dir = os.path.dirname(os.path.realpath(__file__))
+    project = Project(file=os.path.join(dir,'testOntology.yaml'), raft=False)
 
     # check number of mooring lines
     assert len(project.mooringList) == 11
@@ -83,7 +86,8 @@ def test_create_components():
     assert len(project.platformList) == 4
 
 def test_check_connections():
-    project = Project(file='tests/testOntology.yaml',raft=0)
+    dir = os.path.dirname(os.path.realpath(__file__))
+    project = Project(file=os.path.join(dir,'testOntology.yaml'), raft=False)
     # check connections
     for i,anch in enumerate(project.anchorList.values()):
 
@@ -109,15 +113,17 @@ def test_check_connections():
             assert len(pf.attachments) == 6 # 3 lines, 1 turbine, 2 cables
 
 def test_headings_repositioning():
-    project = Project(file='tests/testOntology.yaml',raft=0)
+    dir = os.path.dirname(os.path.realpath(__file__))
+    project = Project(file=os.path.join(dir,'testOntology.yaml'), raft=False)
     # check angles and repositioning for regular mooring line and shared mooring line, reg cable and suspended cable
     assert_allclose(np.hstack((project.mooringList['FOWT1a'].rA,project.mooringList['FOWT1-FOWT2'].rA)),
                     np.hstack(([-828.637,-828.637,-600],[40.5,0,-20])),rtol=0,atol=0.5)
     assert_allclose(np.hstack((project.cableList['array_cable12'].subcomponents[0].rB,project.cableList['cable0'].subcomponents[0].rB)),
                     np.hstack(([605,0,-600],[0,1615.5,-20])),rtol=0,atol=0.5)
 
 def test_marine_growth():
-    project = Project(file='tests/testOntology.yaml',raft=0)
+    dir = os.path.dirname(os.path.realpath(__file__))
+    project = Project(file=os.path.join(dir,'testOntology.yaml'), raft=False)
     # check correct mg gets added to specified mooring lines and cables for ss_mod
     project.getMarineGrowth(lines=['FOWT1a',['cable0',0]])
     # pull out a mooring line and a cable to check
@@ -133,7 +139,8 @@ def test_seabed():
     '''test seabed properties are properly loaded from a file'''
     # check soil at a location
     project = Project()
-    project.loadSoil(filename='tests/soil_sample.txt')
+    dir = os.path.dirname(os.path.realpath(__file__))
+    project.loadSoil(filename=os.path.join(dir,'soil_sample.txt'))
     soilInfo = project.getSoilAtLocation(-828.637,-828.637)
     assert soilInfo[0] == 'mud_soft'
     assert soilInfo[1]['Su0'] == 2.39