Making sure all hyperlinks and names reference 'fad' instead of 'famodel'

Author: shousner

README.md

@@ -37,7 +37,7 @@ and designs.
 See example use cases in our [examples](./examples/README.md) folder.
 
 For working with the library, it is important to understand the floating array 
-model structure, which is described more [here](./famodel/README.md).
+model structure, which is described more [here](./fad/README.md).
 
 
 ## Installation
@@ -121,7 +121,7 @@ Please navigate into the subfolders above for additional information.
 The easiest way to create a FAD project is to provide the array 
 information in an ontology yaml file. FAD has been designed
 to work with a specific ontology yaml setup, which is described 
-in detail in the [Ontology ReadMe](./famodel/ontology/README.md).
+in detail in the [Ontology ReadMe](./fad/ontology/README.md).
 
 For examples of ontologies and driver files of common use cases, 
 we recommend starting with the numbered examples in the examples folder.
@@ -133,15 +133,15 @@ in the ontology.
 To see an example with all use cases, the [example driver file](./examples/example_driver.py) creates a FAD Project 
 object from a pre-set ontology file and shows the syntax and outputs of 
 various capabilities. For guidance on creating your own ontology yaml file, 
-it is recommended to read through the [Ontology ReadMe](./famodel/ontology/README.md), 
+it is recommended to read through the [Ontology ReadMe](./fad/ontology/README.md), 
 then either adapt one of the ontology samples or fill in the ontology template. 
 
-The [core model readme](./famodel/README.md) describes the Project class structure, 
+The [core model readme](./fad/README.md) describes the Project class structure, 
 as well as the properties and methods of each component class. 
 
 There are some limited helper functions to automatically fill in sections 
 of a yaml from a MoorPy system or a list of platform locations. 
-See [helpers](./famodel/helpers.py) for the full list of yaml writing capabilities. 
+See [helpers](./fad/helpers.py) for the full list of yaml writing capabilities. 
 
 
 ## Authors

examples/01_Visualization/02_visual_moorings.yaml

@@ -84,6 +84,6 @@ anchor_types:
     drag-embedment1:
         type   :  DEA   # type of anchor (drag-embedment anchor)
         # additional anchor properties can be defined here, such as d (diameter), m (mass), etc., but are not required for visualization
-        # To see the full list of anchor properties and anchor types, refer to the anchor readme (famodel/anchors/README.md)
+        # To see the full list of anchor properties and anchor types, refer to the anchor readme (fad/anchors/README.md)
 
 

examples/01_Visualization/03_visual_cables.yaml

@@ -44,10 +44,10 @@ array_cables:
     # headingB: compass heading of dynamic cable relative to platform heading (if platform at end B is rotated +15, headingB should be true heading - 15)
     #           In this case, we have a cable coming into fowt1 from fowt0 from the West, so headingB is 270 deg
     #           For the 2nd cable from fowt1 to fowt2, the cable comes into fowt2 from the West, so headingB is also 270 deg
-    # cableType: references a cable type from cable_types section or from famodel/cables/cableProps_default.yaml static cables. 
+    # cableType: references a cable type from cable_types section or from fad/cables/cableProps_default.yaml static cables. 
     #            If no static cable (i.e. a suspended cable design), put NONE
     #            In this case, we have no static cable for the 1st cable because it is suspended, 
-    #              but the 2nd cable has a static cable defined in famodel/cables/cableProps_default.yaml called 'static_cable_66'.
+    #              but the 2nd cable has a static cable defined in fad/cables/cableProps_default.yaml called 'static_cable_66'.
     data:
       - [ fowt0, fowt1, suspended_1, None, 90, 270, None] # suspended cable, so only one dynamic cable configuration, no static cable
       - [ fowt1, fowt2, lazy_wave1,  lazy_wave1, 90, 270, static_cable_66]
@@ -60,11 +60,11 @@ dynamic_cable_configs:
         voltage: 66   # [kV]
         span : 195    # [m] horizontal distance to end of dynamic cable from attachment point
         A: 300        # cable conductor area [mm^2]
-        cable_type: dynamic_cable_66      # ID of a cable section type from famodel/cables/cableProps_default.yaml. Cable props loaded automatically from this!
+        cable_type: dynamic_cable_66      # ID of a cable section type from fad/cables/cableProps_default.yaml. Cable props loaded automatically from this!
         length: 353.505                   # [m] length (unstretched) 
 
         sections: 
-          - type: Buoyancy_750m # name of buoy type from famodel/cables/cableProps_default.yaml - buoy design info read in automatically from this!
+          - type: Buoyancy_750m # name of buoy type from fad/cables/cableProps_default.yaml - buoy design info read in automatically from this!
             L_mid: 200 # [m] length of cable to the midpoint of the buoyancy section from platform connection
             N_modules: 6 # number of buoyancy modules
             spacing: 11.23 # [m] distance between module centers
@@ -75,7 +75,7 @@ dynamic_cable_configs:
         name: Dynamic suspended cable configuration 1 
         voltage: 33 # [kV]
         span: 1512    # [m] horizontal distance to end of dynamic cable from attachment point
-        cable_type: dynamic_cable_66        # ID of a cable section type from famodel/cables/cableProps_default.yaml. Cable props loaded automatically from this!
+        cable_type: dynamic_cable_66        # ID of a cable section type from fad/cables/cableProps_default.yaml. Cable props loaded automatically from this!
         A: 300 # cable conductor area [mm^2]
         length: 1650                   # [m] length (unstretched)
 

examples/02_Mooring_Analysis_MoorPy/02_moorings_cables.yaml

@@ -76,12 +76,12 @@ dynamic_cable_configs:
         voltage: 66 # [kV]
         span : 195    # [m] horizontal distance to end of dynamic cable from attachment point
         A: 300  # cable conductor area [mm^2]
-        cable_type: dynamic_cable_66      # ID of a cable section type from famodel/cables/cableProps_default.yaml. Cable props loaded automatically from this!
+        cable_type: dynamic_cable_66      # ID of a cable section type from fad/cables/cableProps_default.yaml. Cable props loaded automatically from this!
         length: 353.505                   # [m] length (unstretched) 
         rJTube : 5 # [m] radial distance from center of platform that J-tube is located, can be used instead of a J-tube designation in the platform description
 
         sections: 
-          - type: Buoyancy_750m # name of buoy type from famodel/cables/cableProps_default.yaml - buoy design info read in automatically from this!
+          - type: Buoyancy_750m # name of buoy type from fad/cables/cableProps_default.yaml - buoy design info read in automatically from this!
             L_mid: 200 # [m] length of cable from platform connection to midpoint of buoyancy section
             N_modules: 6 # number of buoyancy modules
             spacing: 11.23 # [m] spacing between buoyancy modules
@@ -92,7 +92,7 @@ dynamic_cable_configs:
         name: Dynamic suspended cable configuration 1 
         voltage: 33 # [kV]
         span: 1512    # [m]
-        cable_type: dynamic_cable_66        # ID of a cable section type from famodel/cables/cableProps_default.yaml. Cable props loaded automatically from this!
+        cable_type: dynamic_cable_66        # ID of a cable section type from fad/cables/cableProps_default.yaml. Cable props loaded automatically from this!
         A: 300 # cable conductor area [mm^2]
         length: 1500                   # [m] length (unstretched)
         rJTube : 58 # [m] radial distance from center of platform that J-tube is located

examples/02_Mooring_Analysis_MoorPy/04_array-watch-circle.yaml

@@ -81,12 +81,12 @@ dynamic_cable_configs:
         voltage: 66 # [kV]
         span : 195    # [m] horizontal distance to end of dynamic cable from attachment point
         A: 300  # cable conductor area [mm^2]
-        cable_type: dynamic_cable_66       # ID of a cable section type from famodel/cables/cableProps_default.yaml. Cable props loaded automatically from this!
+        cable_type: dynamic_cable_66       # ID of a cable section type from fad/cables/cableProps_default.yaml. Cable props loaded automatically from this!
         length: 353.505                   # [m] length (unstretched) 
         rJTube : 5 # [m] radial distance from center of platform that J-tube is located
 
         sections: 
-          - type: Buoyancy_750m # name of buoy type from famodel/cables/cableProps_default.yaml - buoy design info read in automatically from this!
+          - type: Buoyancy_750m # name of buoy type from fad/cables/cableProps_default.yaml - buoy design info read in automatically from this!
             L_mid: 200 # [m] from platform connection
             N_modules: 6
             spacing: 11.23 # [m]
@@ -97,7 +97,7 @@ dynamic_cable_configs:
         name: Dynamic suspended cable configuration 1 
         voltage: 33 # [kV]
         span: 1512    # [m]
-        cable_type: dynamic_cable_66        # ID of a cable section type from famodel/cables/cableProps_default.yaml. Cable props loaded automatically from this!
+        cable_type: dynamic_cable_66        # ID of a cable section type from fad/cables/cableProps_default.yaml. Cable props loaded automatically from this!
         A: 300 # cable conductor area [mm^2]
         length: 1500                   # [m] length (unstretched)
         rJTube : 58 # [m] radial distance from center of platform that J-tube is located

examples/02_Mooring_Analysis_MoorPy/05_moorings_cables_marine_growth.yaml

@@ -84,12 +84,12 @@ dynamic_cable_configs:
         voltage: 66 # [kV]
         span : 195    # [m] horizontal distance to end of dynamic cable from attachment point
         A: 300  # cable conductor area [mm^2]
-        cable_type: dynamic_cable_66      # ID of a cable section type from famodel/cables/cableProps_default.yaml. Cable props loaded automatically from this!
+        cable_type: dynamic_cable_66      # ID of a cable section type from fad/cables/cableProps_default.yaml. Cable props loaded automatically from this!
         length: 353.505                   # [m] length (unstretched) 
         rJTube : 5 # [m] radial distance from center of platform that J-tube is located, can be used instead of a J-tube designation in the platform description
 
         sections: 
-          - type: Buoyancy_750m # name of buoy type from famodel/cables/cableProps_default.yaml - buoy design info read in automatically from this!
+          - type: Buoyancy_750m # name of buoy type from fad/cables/cableProps_default.yaml - buoy design info read in automatically from this!
             L_mid: 200 # [m] length of cable from platform connection to midpoint of buoyancy section
             N_modules: 6 # number of buoyancy modules
             spacing: 11.23 # [m] spacing between buoyancy modules
@@ -100,7 +100,7 @@ dynamic_cable_configs:
         name: Dynamic suspended cable configuration 1 
         voltage: 33 # [kV]
         span: 1512    # [m]
-        cable_type: dynamic_cable_66        # ID of a cable section type from famodel/cables/cableProps_default.yaml. Cable props loaded automatically from this!
+        cable_type: dynamic_cable_66        # ID of a cable section type from fad/cables/cableProps_default.yaml. Cable props loaded automatically from this!
         A: 300 # cable conductor area [mm^2]
         length: 1500                   # [m] length (unstretched)
         rJTube : 58 # [m] radial distance from center of platform that J-tube is located

examples/04_Geography/example_geography.ipynb

@@ -53,7 +53,7 @@
    "source": [
     "from pyproj.aoi import AreaOfInterest\n",
     "from pyproj.database import query_utm_crs_info\n",
-    "import famodel.geography as geo\n",
+    "import fad.geography as geo\n",
     "\n",
     "target_crs = geo.getTargetCRS([-125, -124], [40, 41])"
    ]

examples/08_Design_Adjustment/02_Jtubes.yaml

@@ -39,11 +39,11 @@ dynamic_cable_configs:
         voltage: 66 # [kV]
         span : 195    # [m] horizontal distance to end of dynamic cable from attachment point
         A: 300  # cable conductor area [mm^2]
-        cable_type: dynamic_cable_66       # ID of a cable section type from famodel/cables/cableProps_default.yaml. Cable props loaded automatically from this!
+        cable_type: dynamic_cable_66       # ID of a cable section type from fad/cables/cableProps_default.yaml. Cable props loaded automatically from this!
         length: 353.505                   # [m] length (unstretched) 
 
         sections: 
-          - type: Buoyancy_750m # name of buoy type from famodel/cables/cableProps_default.yaml - buoy design info read in automatically from this!
+          - type: Buoyancy_750m # name of buoy type from fad/cables/cableProps_default.yaml - buoy design info read in automatically from this!
             L_mid: 200 # [m] from platform connection
             N_modules: 6
             spacing: 11.23 # [m]
@@ -54,7 +54,7 @@ dynamic_cable_configs:
         name: Dynamic suspended cable configuration 1 
         voltage: 33 # [kV]
         span: 1512    # [m]
-        cable_type: dynamic_cable_66        # ID of a cable section type from famodel/cables/cableProps_default.yaml. Cable props loaded automatically from this!
+        cable_type: dynamic_cable_66        # ID of a cable section type from fad/cables/cableProps_default.yaml. Cable props loaded automatically from this!
         A: 300 # cable conductor area [mm^2]
         length: 1650                   # [m] length (unstretched)
 

fad-env.yaml

@@ -1,4 +1,4 @@
-name: famodel-env
+name: fad-env
 channels:
   - conda-forge
   - defaults

fad/__init__.py

@@ -2,5 +2,4 @@
 from fad.project import Project
 from fad.mooring.mooring import Mooring
 from fad.platform.platform import Platform
-from fad.anchors.anchor import Anchor
-#from famodel.geography import *
+from fad.anchors.anchor import Anchor