Update readme install instructions, small bug fix FLORIS interface, update env yaml for macs

-- readme install instructions updated to be more clear on order of operations
-- small bug fix to ensure only platforms with turbines are considered in FLORIS interface
-- updated env yaml to work for macs as well as pcs

Author: lsirkis

README.md

@@ -21,17 +21,7 @@ of the Humboldt lease area is shown below.
 
 
 ## Installation
-
-To install FAModel itself, clone the FAModel repository and then enter the 
-following in the command line from its directory.
-
-For development use:
-
-run ```python setup.py develop``` or ```pip install -e .``` from the command line in the main FAModel directory.
-
-For non-development use:
-
-run ```python setup.py``` or ```pip install .``` from the command line in the main FAModel directory.
+To install FAModel itself, first clone the FAModel repository.
 
 The dependencies required by FAModel depend on how it is used. To install all
 possible required dependencies, you can create a 
@@ -47,6 +37,17 @@ run the following command:
 This command will install all the dependencies required to run FAModel.
 Activate your virtual environment before using FAModel with ```conda activate famodel-env```
 
+To install the FAModel package in your environment, enter the 
+following in the command line from the FAModel directory.
+
+For development use:
+
+run ```python setup.py develop``` or ```pip install -e .``` from the command line in the main FAModel directory.
+
+For non-development use:
+
+run ```python setup.py``` or ```pip install .``` from the command line in the main FAModel directory.
+
 ** At this time, FAModel requires the latest MoorPy development branch version to be used. **
 Therefore, you must install MoorPy with ```git clone https://github.com/NREL/MoorPy.git```
 then navigate to the MoorPy folder and checkout the development branch with ```git checkout dev```

examples/example_driver.py

@@ -30,7 +30,7 @@
 #%% Section 1: Project without RAFT
 print('Creating project without RAFT\n')
 # create project object
-project = Project(file=ontology_file,raft=0)
+project = Project(file=ontology_file,raft=False)
 # create moorpy system of the array, include cables in the system
 project.getMoorPyArray(cables=1)
 # plot in 3d, using moorpy system for the mooring and cable plots
@@ -40,7 +40,7 @@
 #%% Section 2: Project with RAFT
 print('\nCreating project with RAFT \n')
 #create project object, automatically create RAFT object (and automatically create moorpy system in the process!)
-project = Project(file=ontology_file,raft=1)
+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)
 
@@ -53,7 +53,6 @@
 model.analyzeCases()
 # plot results
 model.plotResponses()
-model.plot()
 
 #%% Section 3: FLORIS
 print('Running FLORIS')

famodel-env.yaml

@@ -699,8 +699,6 @@ def getMG(mgDict):
                     rAth = 0 # exit while loop when we find thickness at low
                     count1 = 0 # counter
                     while rAth==0: # and count1 < len(th):
-                        if count1 == len(th):
-                            breakpoint()
                         if flip:
                             if high[2] <= th[count1][2]:
                                 LThick.append(th[count1][0])

famodel/cables/dynamic_cable.py

@@ -464,7 +464,7 @@ def loadDesign(self, d, raft=1):
                         moor.attachTo(platform, end='B')
 
                         # reposition mooring
-                        moor.reposition(r_center=platform.r, heading=headings[j]+platform.phi)
+                        moor.reposition(r_center=platform.r, heading=headings[j]+platform.phi, project=self)
 
                         # update anchor depth and soils
                         self.updateAnchor(anch=anch)
@@ -521,7 +521,7 @@ def loadDesign(self, d, raft=1):
                     # reposition
                     moor.reposition(r_center=[self.platformList[PFNum[1]].r,
                                               self.platformList[PFNum[0]].r],
-                                    heading=headingB)
+                                    heading=headingB, project=self)
 
                 elif any(ids['ID'] == arrayMooring[j]['endA'] for ids in arrayAnchor): # end A is an anchor
                     # get ID of platform connected to line
@@ -2027,7 +2027,8 @@ def plot2d(self, ax=None, plot_seabed=True,plot_bathymetry=True, plot_boundary=T
         ax.set_xlabel('X (m)')
         ax.set_ylabel('Y (m)')
         if axis_equal:
-            ax.axis('equal')
+            ax.set_aspect('equal',adjustable='box')
+
         handles, labels = plt.gca().get_legend_handles_labels()
         by_label = dict(zip(labels, handles))  # Removing duplicate labels
         ax.legend(by_label.values(), by_label.keys(),loc='upper center',bbox_to_anchor=(0.5, -0.1), fancybox=True, ncol=4)
@@ -2591,7 +2592,8 @@ def getFLORISMPequilibrium(self, ws, wd, ti, cutin, hubht, plotting = True):
         f = interpolate.interp1d(self.windSpeeds, self.thrustForces)
 
         #initialize list of wind speeds (1 wind speed for each turbine)
-        nturbs = len(self.platformList)
+        turblist = [x.body for x in self.platformList.values() if x.entity.upper()=='FOWT']
+        nturbs = len(turblist)
         ws = [ws] * nturbs
 
         winds = []
@@ -2602,31 +2604,31 @@ def getFLORISMPequilibrium(self, ws, wd, ti, cutin, hubht, plotting = True):
         for n in range(0, 2):
 
             # interpolate thrust force from speed/thrust curve
-            for i in range(0, nturbs):
+            for i in range(0,nturbs):
                 if ws[i] < cutin:
                     T = 0
                 else:
                     T = f(ws[i])
 
                 # apply thrust force/moments (split into x and y components)
-                self.ms.bodyList[i].f6Ext = np.array([T*np.cos(np.radians(wd)), T*np.sin(np.radians(wd)), 0, T*np.cos(np.radians(wd))*hubht, T*np.sin(np.radians(wd))*hubht, 0])       # apply an external force on the body 
+                turblist[i].f6Ext = np.array([T*np.cos(np.radians(wd)), T*np.sin(np.radians(wd)), 0, T*np.cos(np.radians(wd))*hubht, T*np.sin(np.radians(wd))*hubht, 0])       # apply an external force on the body 
 
 
             #solve statics to find updated turbine positions
             self.ms.initialize()
             self.ms.solveEquilibrium(DOFtype='both')
 
             #update floris turbine positions and calculate wake losses
-            self.flow.set(layout_x=[body.r6[0] for body in self.ms.bodyList], layout_y=[body.r6[1] for body in self.ms.bodyList])
+            self.flow.set(layout_x=[body.r6[0] for body in turblist], layout_y=[body.r6[1] for body in turblist])
             self.flow.run()
 
 
 
             #update wind speed list for RAFT
             ws = list(self.flow.turbine_average_velocities[0])
             winds.append(ws)
-            xpositions.append([body.r6[0] for body in self.ms.bodyList])
-            ypositions.append([body.r6[1] for body in self.ms.bodyList])
+            xpositions.append([body.r6[0] for body in turblist])
+            ypositions.append([body.r6[1] for body in turblist])
 
 
         #return FLORIS turbine powers (in order of turbine list)
@@ -2684,7 +2686,7 @@ def getFLORISMPequilibrium(self, ws, wd, ti, cutin, hubht, plotting = True):
             #return turbines to neutral positions **** only done if plotting - this reduces runtime for AEP calculation
             for i in range(0, nturbs):
 
-                self.ms.bodyList[i].f6Ext = np.array([0, 0, 0, 0, 0, 0])       # apply an external force on the body 
+                turblist[i].f6Ext = np.array([0, 0, 0, 0, 0, 0])       # apply an external force on the body 
 
             #solve statics to find updated turbine positions
             # self.ms.initialize()