Create directory with unused files

Author: RyanDavies19

famodel/installation/03_step1_materialItems.py

@@ -99,6 +99,6 @@ def create_mtrlPkg(moor):
 for moor in proj.mooringList.values():
     mtrlPkgs.append(create_mtrlPkg(moor))
 
-output = os.path.join(filePath, "mtrlPkgs.pkl")
+output = os.path.join(filePath, "mtrlPkgs.pkl") # TODO: make intermediate files saved to a separate folder
 with open(output, 'wb') as f:
     pickle.dump(mtrlPkgs, f)

famodel/installation/04_step2_actionItems.py

@@ -44,7 +44,7 @@
     vessel['state'] = {
         'remaining_cargo': vessel['storage_specs']['max_cargo'],
         'remaining_deck_space': vessel['storage_specs']['max_deck_space'],
-        'remaining_spool_capacity': vessel['storage_specs']['spool_capacity'],
+        'remaining_spool_capacity': vessel['storage_specs']['max_spool_capacity'],
         'assigned_materials': []
         }
 

famodel/installation/README.md

@@ -34,9 +34,7 @@ Naming convention per Leah: The naming convention used generally for the yamls d
 
 The 01-05 steps were set up with a 3_ILIA_1P2C_grd_mini.yaml, which (I believe) is the same configuration as the Delmar_installation_staging_tool.xlsx, so it that can serve as a verification of this model. if we can't find that input configuration, then we can remake it with the instructions in the `Conceptual Desgin Tutorial.docx` file. 
 
-For getting things running, I changed to ______, from `FADesign/scripts/concepts/ILIA/______`. 
-
-# Copilot Explaination of the tool
+# Copilot Explaination of the tool (outdated)
 
 ## Prompt: Explain the tool
 
@@ -67,7 +65,7 @@ The tool is designed to:
    - Found in install_helpers.py, these functions handle specific tasks like transporting materials, mobilizing vessels, and visualizing actions.
 
 4. **Configuration Files**:
-   - YAML files (e.g., VolturnUS-S_example.yaml, `presetLogistics.yaml`) define input parameters for the simulations, such as mooring configurations and logistics setups.
+   - YAML files define input parameters for the simulations, such as mooring configurations and logistics setups.
 
 5. **Spreadsheet Tool**:
    - `Delmar_installation_staging_tool.xlsm` appears to be a verification or supplementary tool for the model.

famodel/installation/install_manager.py

@@ -96,7 +96,7 @@ def scheduleEvent(self, time, agent, action, params):
         agent : object
             Agent responsible for the action.
         action : str
-            Name of the action to perform.
+            Name of the action to perform. # TODO: this may not be correct, may need to be an action object instead.
         params : dict
             Parameters for the action.