FASTSim Wrapper Sub-Module
t3co.energy_models.fastsim_model.fastsim_wrapper
RunFASTSim
Source code in src/t3co/energy_models/fastsim_model/fastsim_wrapper.py
15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 | |
__new__(*args, **kwargs)
Creates a new instance of the RunFASTSim class.
Source code in src/t3co/energy_models/fastsim_model/fastsim_wrapper.py
22 23 24 25 26 27 | |
load_vehicle(t3co_vehicle=None, veh_no=None, veh_input_path=None, vehicle_df=None, use_rust=True)
Loads vehicle object from vehicle number and input CSV filepath.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
veh_no |
int
|
Vehicle selection number. |
None
|
veh_input_path |
Union[str, Path]
|
Vehicle model assumptions input CSV file path. |
None
|
Returns:
| Type | Description |
|---|---|
Vehicle
|
fastsim.vehicle.Vehicle: FASTSim vehicle object. |
Source code in src/t3co/energy_models/fastsim_model/fastsim_wrapper.py
98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 | |
load_design_cycle_from_scenario(scenario, cyc_file_path=gl.CYCLES_FOLDER, return_rustcycle=True)
Loads the design cycle used for mpgge and range determination.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
scenario |
Scenario
|
Scenario object for current selection. |
required |
cyc_file_path |
Union[str, Path]
|
Drive cycle input file path. Defaults to gl.CYCLES_FOLDER. |
CYCLES_FOLDER
|
Returns:
| Type | Description |
|---|---|
Union[Cycle, List[Cycle]]
|
Union[fastsim.cycle.Cycle, List[fastsim.cycle.Cycle]]: FASTSim cycle object for current Scenario object. |
Source code in src/t3co/energy_models/fastsim_model/fastsim_wrapper.py
139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 | |
load_design_cycle_from_path(cyc_file_path, return_rustcycle=True)
Loads the Cycle object from the drive cycle filepath.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
cyc_file_path |
Union[str, Path]
|
Drive cycle input file path. |
required |
Returns:
| Type | Description |
|---|---|
Union[RustCycle, Cycle]
|
fastsim.cycle.Cycle: FASTSim cycle object for current Scenario object. |
Source code in src/t3co/energy_models/fastsim_model/fastsim_wrapper.py
199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 | |
get_simdrive(cycle)
Creates a SimDrive object for the given cycle and vehicle.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
cycle |
Cycle
|
The drive cycle. |
required |
Returns:
| Type | Description |
|---|---|
RustSimDrive
|
fastsim.fastsimrust.RustSimDrive: The RustSimDrive object. |
Source code in src/t3co/energy_models/fastsim_model/fastsim_wrapper.py
226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 | |
get_range()
Calculates the range of the vehicle based on its type and energy storage.
Source code in src/t3co/energy_models/fastsim_model/fastsim_wrapper.py
256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 | |
get_accel_cycle()
staticmethod
Creates the acceleration test cycle.
Source code in src/t3co/energy_models/fastsim_model/fastsim_wrapper.py
281 282 283 284 285 286 287 288 289 290 291 292 | |
get_grade_cycle(target_grade, scenario=None)
staticmethod
Creates the gradeability test cycle.
Source code in src/t3co/energy_models/fastsim_model/fastsim_wrapper.py
294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 | |