Fix/speed trace from slts in ssts

python/altrios/demos/set_speed_train_sim_demo.py

@@ -65,12 +65,14 @@
     alt.resources_root() / rail_vehicle_file)
 
 network = alt.Network.from_file(
-    alt.resources_root() / "networks/Taconite.yaml")
+    alt.resources_root() / "networks/Taconite-NoBalloon.yaml")
 network.set_speed_set_for_train_type(alt.TrainType.Freight)
+# file created from ./speed_limit_train_sim_demo.py:L92
 link_path = alt.LinkPath.from_csv_file(
-    alt.resources_root() / "demo_data/link_points_idx.csv"
+    alt.resources_root() / "demo_data/link_path.csv"
 )
 
+# file created from ./speed_limit_train_sim_demo.py:L105
 speed_trace = alt.SpeedTrace.from_csv_file(
     alt.resources_root() / "demo_data/speed_trace.csv"
 )
@@ -89,7 +91,9 @@
 t1 = time.perf_counter()
 print(f'Time to simulate: {t1 - t0:.5g}')
 
-fig, ax = plt.subplots(3, 1, sharex=True)
+loco0: alt.Locomotive = train_sim.loco_con.loco_vec.tolist()[0]
+
+fig, ax = plt.subplots(4, 1, sharex=True)
 ax[0].plot(
     np.array(train_sim.history.time_seconds) / 3_600,
     np.array(train_sim.history.pwr_whl_out_watts) / 1e6,
@@ -126,17 +130,85 @@
 ax[1].set_ylabel('Force [MN]')
 ax[1].legend()
 
+ax[2].plot(
+    np.array(train_sim.history.time_seconds) / 3_600,
+    np.array(loco0.res.history.soc)
+)
+ax[2].set_ylabel('SOC')
+
 ax[-1].plot(
     np.array(train_sim.history.time_seconds) / 3_600,
-    train_sim.speed_trace.speed_meters_per_second,
+    train_sim.history.speed_meters_per_second,
+    label='achieved'
+)
+ax[-1].plot(
+    np.array(train_sim.history.time_seconds) / 3_600,
+    train_sim.history.speed_limit_meters_per_second,
+    label='limit'
 )
 ax[-1].set_xlabel('Time [hr]')
 ax[-1].set_ylabel('Speed [m/s]')
+ax[-1].legend()
+plt.suptitle("Set Speed Train Sim Demo")
+
+fig1, ax1 = plt.subplots(3, 1, sharex=True)
+ax1[0].plot(
+    np.array(train_sim.history.time_seconds) / 3_600,
+    np.array(train_sim.history.offset_in_link_meters) / 1_000,
+    label='current link',
+)
+ax1[0].plot(
+    np.array(train_sim.history.time_seconds) / 3_600,
+    np.array(train_sim.history.offset_meters) / 1_000,
+    label='overall',
+)
+ax1[0].legend()
+ax1[0].set_ylabel('Net Dist. [km]')
+
+ax1[1].plot(
+    np.array(train_sim.history.time_seconds) / 3_600,
+    train_sim.history.link_idx_front,
+    linestyle='',
+    marker='.',
+)
+ax1[1].set_ylabel('Link Idx Front')
+
+ax1[-1].plot(
+    np.array(train_sim.history.time_seconds) / 3_600,
+    train_sim.history.speed_meters_per_second,
+)
+ax1[-1].set_xlabel('Time [hr]')
+ax1[-1].set_ylabel('Speed [m/s]')
 
 plt.suptitle("Set Speed Train Sim Demo")
+plt.tight_layout()
 
-if SHOW_PLOTS:
-    plt.tight_layout()
-    plt.show()
 
-# %%
+
+fig2, ax2 = plt.subplots(3, 1, sharex=True)
+ax2[0].plot(
+    np.array(train_sim.history.time_seconds) / 3_600,
+    np.array(train_sim.history.pwr_whl_out_watts) / 1e6,
+    label="tract pwr",
+)
+ax2[0].set_ylabel('Power [MW]')
+ax2[0].legend()
+
+ax2[1].plot(
+    np.array(train_sim.history.time_seconds) / 3_600,
+    np.array(train_sim.history.grade_front) * 100.,
+)
+ax2[1].set_ylabel('Grade [%] at\nHead End')
+
+ax2[-1].plot(
+    np.array(train_sim.history.time_seconds) / 3_600,
+    train_sim.history.speed_meters_per_second,
+)
+ax2[-1].set_xlabel('Time [hr]')
+ax2[-1].set_ylabel('Speed [m/s]')
+
+plt.suptitle("Set Speed Train Sim Demo")
+plt.tight_layout()
+
+if SHOW_PLOTS:
+    plt.show()

python/altrios/demos/speed_limit_train_sim_demo.py

@@ -10,7 +10,7 @@
 
 SHOW_PLOTS = alt.utils.show_plots()
 
-SAVE_INTERVAL = 100
+SAVE_INTERVAL = 1
 
 # https://docs.rs/altrios-core/latest/altrios_core/train/struct.TrainConfig.html
 train_config = alt.TrainConfig(
@@ -74,7 +74,7 @@
 train_sim: alt.SpeedLimitTrainSim = tsb.make_speed_limit_train_sim(
     rail_vehicle=rail_vehicle,
     location_map=location_map,
-    save_interval=1,
+    save_interval=SAVE_INTERVAL,
 )
 train_sim.set_save_interval(SAVE_INTERVAL)
 
@@ -88,6 +88,10 @@
     False,
 )[0]
 
+# Uncomment the following lines to overwrite `set_speed_train_sim_demo.py` `link_path`
+# link_path = alt.LinkPath([x.link_idx for x in timed_link_path.tolist()])
+# link_path.to_csv_file(alt.resources_root() / "demo_data/link_path.csv")
+
 # uncomment this line to see example of logging functionality
 # alt.utils.set_log_level("DEBUG")
 
@@ -100,6 +104,15 @@
 print(f'Time to simulate: {t1 - t0:.5g}')
 assert len(train_sim.history) > 1
 
+# Uncomment the following lines to overwrite `set_speed_train_sim_demo.py` `speed_trace`
+speed_trace = alt.SpeedTrace(
+    train_sim.history.time_seconds.tolist(),
+    train_sim.history.speed_meters_per_second.tolist()
+)
+speed_trace.to_csv_file(
+    alt.resources_root() / "demo_data/speed_trace.csv"
+)
+
 loco0:alt.Locomotive = train_sim.loco_con.loco_vec.tolist()[0]
 
 fig, ax = plt.subplots(4, 1, sharex=True)
@@ -220,6 +233,5 @@
 
 
 if SHOW_PLOTS:
-    plt.tight_layout()
     plt.show()
 # Impact of sweep of battery capacity TODO: make this happen

python/altrios/optimization/cal_and_val.py

@@ -65,10 +65,12 @@ class ModelError(object):
     """
     Dataclass class for calculating model error of various ALTRIOS objects w.r.t. test data.
 
-    Fields:
+    Attributes:
     - `ser_model_dict`:  `dict` variable in which:
-        - key: a `str` representing trip keyword string
-        - value: a `str` converted from Rust locomotive models' serialization method
+
+    - key: a `str` representing trip keyword string
+
+    - value: a `str` converted from Rust locomotive models' serialization method
 
     - `model_type`: `str` that can only be `'ConsistSimulation'`, `'SetSpeedTrainSim'` or `'LocomotiveSimulation'`;
       indicates which model to instantiate during optimization process
@@ -85,7 +87,11 @@ class ModelError(object):
     - `params`: a tuple whose individual element is a `str` containing hierarchical paths to parameters
       to manipulate starting from one of the 3 possible Rust model structs
 
-    - `verbose`: `bool`; if `True`, the verbose of error calculation will be printed 
+    - `verbose`: `bool`: if `True`, the verbose of error calculation will be printed 
+
+    - `debug`: `bool`: if `True`, prints more stuff
+
+    - `allow_partial`: whether to allow partial runs, if True, errors out whenever a run can't be completed
     """
     # `ser_model_dict` and `dfs` should have the same keys
     ser_model_dict: Dict[str, str]

python/altrios/resources/demo_data/link_path.csv

@@ -0,0 +1,92 @@
+link_idx
+71
+70
+69
+72
+164
+163
+74
+67
+608
+895
+167
+170
+168
+169
+172
+76
+78
+77
+80
+362
+180
+179
+79
+371
+75
+82
+183
+186
+83
+372
+375
+48
+84
+47
+227
+229
+621
+616
+909
+722
+623
+595
+656
+620
+622
+625
+782
+785
+598
+891
+780
+778
+779
+781
+776
+777
+927
+936
+913
+916
+540
+1013
+1007
+1017
+1015
+1010
+1012
+1011
+1008
+1009
+1016
+553
+1018
+1014
+986
+983
+1034
+560
+1053
+508
+502
+505
+504
+507
+510
+513
+521
+558
+559
+556
+557