Add instructions to readme, make bug fixes and path fixes and add input files to get exmaples to run, added TODOs

Author: RyanDavies19

famodel/installation/01_unload4installation.py

@@ -1,6 +1,8 @@
 """
 Script to unload a project class from a ConceptDesign class.
 
+This just sets up a project, does not test the install model. 
+
 Steps
 -----
 1. Load the ConceptDesign object.
@@ -28,7 +30,7 @@
 # ILIA | 3_ILIA_1P2C_grd_mini (caseI for installation)
 
 category    = "ILIA"
-conceptName = "3_ILIA_1P2C_grd_mini"
+conceptName = "3_ILIA_al[cr]_grd"
 
 # FILE LOCATIONS
 filePath = os.path.dirname(os.path.abspath(__file__))

famodel/installation/02_load4installation.py

@@ -1,6 +1,8 @@
 """
 This example loads a project class and conducts some analysis and performance metrics. 
 
+This just sets up a project, does not test the install model. 
+
 NOTE: If the project yaml file does not exist, please run 01_unload_driver.py before this 
 so you have a project that you can load here in this example. The project yaml file generated 
 by the unload driver is named proj_{<concept name>}. Insert that in the inputFile in this script.
@@ -25,7 +27,7 @@
 
 # CONCEPT CATEGORY & NAME
 category    = "ILIA"  # ILIA | ILSA | SLIA | SLSA | hybrid 
-conceptName = "3_ILIA_1P2C_grd_mini"
+conceptName = "3_ILIA_al[cr]_grd"
 
 # FILE LOCATIONS
 filePath     = os.path.dirname(os.path.abspath(__file__))

famodel/installation/03_step1_materialItems.py

@@ -85,7 +85,8 @@ def create_mtrlPkg(moor):
 
 # CONCEPT CATEGORY & NAME
 category    = "ILIA"  # ILIA | ILSA | SLIA | SLSA | hybrid 
-conceptName = "3_ILIA_1P2C_grd_mini"
+conceptName = "3_ILIA_al[cr]_grd"
+
 # FILE LOCATIONS
 filePath     = os.path.dirname(os.path.abspath(__file__))
 inputFile    = os.path.join(filePath, category, f"proj_{conceptName}.yaml")

famodel/installation/04_step2_actionItems.py

@@ -1,5 +1,5 @@
 """
-Script to generate action items for transport, mobilization, and installation.
+loads material package saved in step1, loads vessel description, and creates action items for transport, mobilization, and installation.
 
 Steps
 -----
@@ -11,7 +11,7 @@
 None
 """
 
-'''loads material package saved in step1, loads vessel description, and creates action items for transport, mobilization, and installation.'''
+
 import matplotlib.pyplot as plt
 import os
 from fadesign.conceptual.conceptDesign import ConceptDesign
@@ -22,7 +22,7 @@
 import yaml
 import networkx as nx
 import pickle 
-import install_helpers as inst
+from . import install_helpers as inst
 
 
 # FILE LOCATIONS
@@ -55,6 +55,9 @@
 # Mobilization
 pkg = pkgs[0] # example
 mobilize_V1, vessel = inst.mobilizeM_actionItem(vessel, pkg)
+
+# TODO: This seems like the same as vessel.mobilize? Are these two different approaches that are duplicates? How do we map this out? 
+
 print(vessel['state'])
 # Installation
 pkg = pkgs[0] # example

famodel/installation/05_install_ex.py

@@ -1,5 +1,6 @@
 """
-Script to integrate all steps into a complete installation simulation.
+an example of how install manager is used to register a vessel and port, and schedule an event and run (not finished yet).
+This is independent of 04_step2_actionItems.py and 03_step1_materialItems.py
 
 Steps
 -----
@@ -11,28 +12,27 @@
 None
 """
 
-'''an example of how install manager is used to register a vessel and port, and schedule an event and run (not finished yet).'''
 # from fadesign.conceptual.installation.vessel import Vessel
 # from fadesign.conceptual.installation.port import Port
-from fadesign.installation.install_manager import InstallManager as IM
+from .install_manager import InstallManager as IM
 from pyproj import Proj, Transformer
 import pandas as pd
 import os
 
 # FILE LOCATIONS
 filePath     = os.path.dirname(os.path.abspath(__file__))
 vessel1_file = os.path.join(filePath, "ahts.yaml")
-port1_file   = os.path.join(filePath, "port_of_humboldt.yaml")
+port1_file   = os.path.join(filePath, "humboldt_bay.yaml")
 
 # Initialize
 im = IM()
 
 # Register Port
-im.registerPort()
+im.registerPort(port1_file)
 # Register Vessels
 im.registerVessel(vessel1_file)
 
 # Register vessel mob activity
-im.scheduleEvent(im.now, im.vessels['ahts1'], action='mob', params={"portLocation": [0, 0]})
+im.scheduleEvent(im.now, im.vesselList['3gs'], action='mob', params={"portLocation": [0, 0]}) # TODO: how does this relate to 04? In 04 you create actions. Here you schedule events and it seems like the action is defined as a method of the class (not a separate object).
 # Register 
 im.run()