Skip to content

Introduce aux efficiency field aux_eff for FC and RES, deprecate Conv alt_eff #304

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
kylecarow wants to merge 47 commits into
base: fastsim-3
Choose a base branch
from
Open

Introduce aux efficiency field aux_eff for FC and RES, deprecate Conv alt_eff #304

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
47 commits
Select commit Hold shift + click to select a range
c9471d1
dev section fillout & cleanup
kylecarow Jun 30, 2026
e941efe
Clarify Anaconda environment setup instructions
kylecarow Jul 2, 2026
9b0904a
added note about conda install from pixi.lock
kylecarow Jul 3, 2026
160a554
restructure docs, add some tag ability to demos_to_notebooks, fill ou…
kylecarow Jul 9, 2026
60096d2
frame up vehicle hierarchy
kylecarow Jul 9, 2026
f711150
updated getting started demo with mines demo content, updated getting…
Jul 9, 2026
a1e5e19
vehicle docs progress
kylecarow Jul 10, 2026
4e58758
add nbformat dep to tests
kylecarow Jul 10, 2026
87742ec
Merge branch 'f3/docs/demos' into f3/getting-started
kylecarow Jul 10, 2026
667aa68
replace accidentally removed line in plot_utils
kylecarow Jul 10, 2026
87e351a
Merge branch 'f3/docs/demos' into f3/getting-started
kylecarow Jul 10, 2026
cb61f14
Merge branch 'f3/docs/dev' into f3/docs/demos
kylecarow Jul 10, 2026
da73a00
describe release process
kylecarow Jul 10, 2026
13a5f8d
polish installation and developer sections
kylecarow Jul 10, 2026
f6695a1
Merge pull request #268 from NatLabRockies/f3/getting-started
kylecarow Jul 10, 2026
28faaf2
link to DriveCAT
kylecarow Jul 10, 2026
9713160
delete old dev instructions
kylecarow Jul 10, 2026
0141702
finish vehicle hierarchy page
kylecarow Jul 14, 2026
cb34c0b
label_fe to ipynb
kylecarow Jul 14, 2026
933eb15
remove demo scripts, refactor as jupyter notebooks instead. we can te…
kylecarow Jul 14, 2026
950ffba
update demos to not expect old directory
kylecarow Jul 14, 2026
b192e11
Merge branch 'fastsim-3' into f3/docs/demos
kylecarow Jul 14, 2026
af46a91
reorganize docs directory to reflect toc structure
kylecarow Jul 14, 2026
5bcd169
hypenate notebook filenames, fix broken internal links
kylecarow Jul 14, 2026
f8cd95a
use empty brackets for links between md files to autofill heading
kylecarow Jul 14, 2026
2f513a1
fix reset name bug
kylecarow Jul 14, 2026
25df883
simdrive demo
kylecarow Jul 14, 2026
d73d132
fill out trace miss demo
kylecarow Jul 14, 2026
61ff2fa
frame up advanced sim section
kylecarow Jul 14, 2026
b210081
modeling-vehicle notebook complete
kylecarow Jul 14, 2026
c5a78cb
remove straggling page links with custom titles
kylecarow Jul 14, 2026
3926739
simparams section complete
kylecarow Jul 14, 2026
c23fc9c
start-stop demo
kylecarow Jul 15, 2026
35ca6d4
dfco demo
kylecarow Jul 15, 2026
5ad5119
cavs demo
kylecarow Jul 15, 2026
b02eaf5
advanced demos complete
kylecarow Jul 15, 2026
4b05115
update plot coloring throughout docs
kylecarow Jul 15, 2026
8a8d36e
fix bottom of getting started demo
kylecarow Jul 15, 2026
1a092cf
add common efficiency validation in macro
kylecarow Jul 15, 2026
492d10d
Merge branch 'fastsim-3' into f3/efficiency
kylecarow Jul 18, 2026
92d7e3e
Merge branch 'fastsim-3' into f3/efficiency
kylecarow Jul 19, 2026
a3b0320
preliminary aux load eff for RES
kylecarow Jul 20, 2026
579a387
switch from alt_eff to aux_eff for conv, proper compat plumbing and c…
kylecarow Jul 20, 2026
478e31c
regenerated vehicles
kylecarow Jul 20, 2026
265cab8
add version number to deprecate notice
kylecarow Jul 20, 2026
b0741c2
aux_supply_eff mandatory (defaults to 100%)
kylecarow Jul 21, 2026
0674b6f
minor init cleanup
kylecarow Jul 21, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
5 changes: 1 addition & 4 deletions .github/workflows/deploy_docs.yaml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -58,10 +58,7 @@ jobs:
# base path to build correct links to its static assets.
env:
BASE_URL: "/${{ github.event.repository.name }}"
# TODO: consider adding --strict once a strict + execute build is
# confirmed clean, so broken links/refs and execution errors fail the
# deploy instead of silently publishing.
run: jupyter book build --html --execute
run: jupyter book build --strict --html --execute

- name: Upload artifact
uses: actions/upload-pages-artifact@v3
Expand Down
3 changes: 2 additions & 1 deletion cal_and_val/f3-vehicles/2010 Mazda 3 i-Stop.yaml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -56,6 +56,8 @@ pt_type:
strategy: Linear
extrapolate: Error
pwr_idle_fuel_watts: 0.0
aux_supply_eff:
Constant: 1.0
state:
i: 0
pwr_out_max_watts: 0.0
Expand Down Expand Up @@ -126,7 +128,6 @@ pt_type:
i: []
vehicle_dynamics_prevent_dfco: []
mass_kilograms: ~
alt_eff: 1.0
chassis:
drag_coef: 0.3301
frontal_area_square_meters: 2.574
Expand Down
3 changes: 2 additions & 1 deletion cal_and_val/f3-vehicles/2012 Ford Focus.yaml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -56,6 +56,8 @@ pt_type:
strategy: Linear
extrapolate: Error
pwr_idle_fuel_watts: 0.0
aux_supply_eff:
Constant: 1.0
state:
i: 0
pwr_out_max_watts: 0.0
Expand Down Expand Up @@ -126,7 +128,6 @@ pt_type:
i: []
vehicle_dynamics_prevent_dfco: []
mass_kilograms: ~
alt_eff: 1.0
chassis:
drag_coef: 0.304
frontal_area_square_meters: 2.574
Expand Down
3 changes: 2 additions & 1 deletion cal_and_val/f3-vehicles/2012 Ford Fusion.yaml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -56,6 +56,8 @@ pt_type:
strategy: Linear
extrapolate: Error
pwr_idle_fuel_watts: 0.0
aux_supply_eff:
Constant: 1.0
state:
i: 0
pwr_out_max_watts: 0.0
Expand Down Expand Up @@ -126,7 +128,6 @@ pt_type:
i: []
vehicle_dynamics_prevent_dfco: []
mass_kilograms: ~
alt_eff: 1.0
chassis:
drag_coef: 0.393
frontal_area_square_meters: 2.12
Expand Down
3 changes: 2 additions & 1 deletion cal_and_val/f3-vehicles/2016 AUDI A3 4cyl 2WD.yaml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -56,6 +56,8 @@ pt_type:
strategy: Linear
extrapolate: Error
pwr_idle_fuel_watts: 0.0
aux_supply_eff:
Constant: 1.0
state:
i: 0
pwr_out_max_watts: 0.0
Expand Down Expand Up @@ -126,7 +128,6 @@ pt_type:
i: []
vehicle_dynamics_prevent_dfco: []
mass_kilograms: ~
alt_eff: 1.0
chassis:
drag_coef: 0.395
frontal_area_square_meters: 2.565
Expand Down
3 changes: 2 additions & 1 deletion cal_and_val/f3-vehicles/2016 BMW 328d 4cyl 2WD.yaml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -56,6 +56,8 @@ pt_type:
strategy: Linear
extrapolate: Error
pwr_idle_fuel_watts: 0.0
aux_supply_eff:
Constant: 1.0
state:
i: 0
pwr_out_max_watts: 0.0
Expand Down Expand Up @@ -126,7 +128,6 @@ pt_type:
i: []
vehicle_dynamics_prevent_dfco: []
mass_kilograms: ~
alt_eff: 1.0
chassis:
drag_coef: 0.3
frontal_area_square_meters: 2.565
Expand Down
4 changes: 4 additions & 0 deletions cal_and_val/f3-vehicles/2016 BMW i3 REx PHEV.yaml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -14,6 +14,8 @@ pt_type:
Constant: 0.9848857801796105
min_soc: 0.25
max_soc: 0.9
aux_supply_eff:
Constant: 1.0
state:
pwr_prop_max_watts: 0.0
pwr_regen_max_watts: 0.0
Expand Down Expand Up @@ -109,6 +111,8 @@ pt_type:
strategy: Linear
extrapolate: Error
pwr_idle_fuel_watts: 0.0
aux_supply_eff:
Constant: 1.0
state:
i: 0
pwr_out_max_watts: 0.0
Expand Down
3 changes: 2 additions & 1 deletion cal_and_val/f3-vehicles/2016 CHEVROLET Malibu 4cyl 2WD.yaml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -56,6 +56,8 @@ pt_type:
strategy: Linear
extrapolate: Error
pwr_idle_fuel_watts: 0.0
aux_supply_eff:
Constant: 1.0
state:
i: 0
pwr_out_max_watts: 0.0
Expand Down Expand Up @@ -126,7 +128,6 @@ pt_type:
i: []
vehicle_dynamics_prevent_dfco: []
mass_kilograms: ~
alt_eff: 1.0
chassis:
drag_coef: 0.3
frontal_area_square_meters: 2.732
Expand Down
2 changes: 2 additions & 0 deletions cal_and_val/f3-vehicles/2016 CHEVROLET Spark EV.yaml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -14,6 +14,8 @@ pt_type:
Constant: 0.9848857801796105
min_soc: 0.03
max_soc: 0.98
aux_supply_eff:
Constant: 1.0
state:
pwr_prop_max_watts: 0.0
pwr_regen_max_watts: 0.0
Expand Down
4 changes: 4 additions & 0 deletions cal_and_val/f3-vehicles/2016 CHEVROLET Volt.yaml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -14,6 +14,8 @@ pt_type:
Constant: 0.9848857801796105
min_soc: 0.15
max_soc: 0.9
aux_supply_eff:
Constant: 1.0
state:
pwr_prop_max_watts: 0.0
pwr_regen_max_watts: 0.0
Expand Down Expand Up @@ -109,6 +111,8 @@ pt_type:
strategy: Linear
extrapolate: Error
pwr_idle_fuel_watts: 0.0
aux_supply_eff:
Constant: 1.0
state:
i: 0
pwr_out_max_watts: 0.0
Expand Down
4 changes: 4 additions & 0 deletions cal_and_val/f3-vehicles/2016 FORD C-MAX (PHEV).yaml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -14,6 +14,8 @@ pt_type:
Constant: 0.9848857801796105
min_soc: 0.15
max_soc: 0.9
aux_supply_eff:
Constant: 1.0
state:
pwr_prop_max_watts: 0.0
pwr_regen_max_watts: 0.0
Expand Down Expand Up @@ -109,6 +111,8 @@ pt_type:
strategy: Linear
extrapolate: Error
pwr_idle_fuel_watts: 0.0
aux_supply_eff:
Constant: 1.0
state:
i: 0
pwr_out_max_watts: 0.0
Expand Down
4 changes: 4 additions & 0 deletions cal_and_val/f3-vehicles/2016 FORD C-MAX HEV.yaml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -14,6 +14,8 @@ pt_type:
Constant: 0.9848857801796105
min_soc: 0.4
max_soc: 0.8
aux_supply_eff:
Constant: 1.0
state:
pwr_prop_max_watts: 0.0
pwr_regen_max_watts: 0.0
Expand Down Expand Up @@ -109,6 +111,8 @@ pt_type:
strategy: Linear
extrapolate: Error
pwr_idle_fuel_watts: 0.0
aux_supply_eff:
Constant: 1.0
state:
i: 0
pwr_out_max_watts: 0.0
Expand Down
3 changes: 2 additions & 1 deletion cal_and_val/f3-vehicles/2016 FORD Escape 4cyl 2WD.yaml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -56,6 +56,8 @@ pt_type:
strategy: Linear
extrapolate: Error
pwr_idle_fuel_watts: 0.0
aux_supply_eff:
Constant: 1.0
state:
i: 0
pwr_out_max_watts: 0.0
Expand Down Expand Up @@ -126,7 +128,6 @@ pt_type:
i: []
vehicle_dynamics_prevent_dfco: []
mass_kilograms: ~
alt_eff: 1.0
chassis:
drag_coef: 0.355
frontal_area_square_meters: 3.066
Expand Down
3 changes: 2 additions & 1 deletion cal_and_val/f3-vehicles/2016 FORD Explorer 4cyl 2WD.yaml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -56,6 +56,8 @@ pt_type:
strategy: Linear
extrapolate: Error
pwr_idle_fuel_watts: 0.0
aux_supply_eff:
Constant: 1.0
state:
i: 0
pwr_out_max_watts: 0.0
Expand Down Expand Up @@ -126,7 +128,6 @@ pt_type:
i: []
vehicle_dynamics_prevent_dfco: []
mass_kilograms: ~
alt_eff: 1.0
chassis:
drag_coef: 0.34
frontal_area_square_meters: 3.568
Expand Down
3 changes: 2 additions & 1 deletion cal_and_val/f3-vehicles/2016 HYUNDAI Elantra 4cyl 2WD.yaml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -56,6 +56,8 @@ pt_type:
strategy: Linear
extrapolate: Error
pwr_idle_fuel_watts: 0.0
aux_supply_eff:
Constant: 1.0
state:
i: 0
pwr_out_max_watts: 0.0
Expand Down Expand Up @@ -126,7 +128,6 @@ pt_type:
i: []
vehicle_dynamics_prevent_dfco: []
mass_kilograms: ~
alt_eff: 1.0
chassis:
drag_coef: 0.3
frontal_area_square_meters: 2.611
Expand Down
4 changes: 4 additions & 0 deletions cal_and_val/f3-vehicles/2016 HYUNDAI Sonata PHEV.yaml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -14,6 +14,8 @@ pt_type:
Constant: 0.9848857801796105
min_soc: 0.15
max_soc: 0.9
aux_supply_eff:
Constant: 1.0
state:
pwr_prop_max_watts: 0.0
pwr_regen_max_watts: 0.0
Expand Down Expand Up @@ -109,6 +111,8 @@ pt_type:
strategy: Linear
extrapolate: Error
pwr_idle_fuel_watts: 0.0
aux_supply_eff:
Constant: 1.0
state:
i: 0
pwr_out_max_watts: 0.0
Expand Down
4 changes: 4 additions & 0 deletions cal_and_val/f3-vehicles/2016 Hyundai Tucson Fuel Cell.yaml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -14,6 +14,8 @@ pt_type:
Constant: 0.9848857801796105
min_soc: 0.4
max_soc: 0.8
aux_supply_eff:
Constant: 1.0
state:
pwr_prop_max_watts: 0.0
pwr_regen_max_watts: 0.0
Expand Down Expand Up @@ -109,6 +111,8 @@ pt_type:
strategy: Linear
extrapolate: Error
pwr_idle_fuel_watts: 0.0
aux_supply_eff:
Constant: 1.0
state:
i: 0
pwr_out_max_watts: 0.0
Expand Down
4 changes: 4 additions & 0 deletions cal_and_val/f3-vehicles/2016 KIA Optima Hybrid.yaml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -14,6 +14,8 @@ pt_type:
Constant: 0.9848857801796105
min_soc: 0.4
max_soc: 0.8
aux_supply_eff:
Constant: 1.0
state:
pwr_prop_max_watts: 0.0
pwr_regen_max_watts: 0.0
Expand Down Expand Up @@ -109,6 +111,8 @@ pt_type:
strategy: Linear
extrapolate: Error
pwr_idle_fuel_watts: 0.0
aux_supply_eff:
Constant: 1.0
state:
i: 0
pwr_out_max_watts: 0.0
Expand Down
2 changes: 2 additions & 0 deletions cal_and_val/f3-vehicles/2016 Leaf 24 kWh.yaml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -14,6 +14,8 @@ pt_type:
Constant: 0.9848857801796105
min_soc: 0.05
max_soc: 0.95
aux_supply_eff:
Constant: 1.0
state:
pwr_prop_max_watts: 0.0
pwr_regen_max_watts: 0.0
Expand Down
2 changes: 2 additions & 0 deletions cal_and_val/f3-vehicles/2016 MITSUBISHI i-MiEV.yaml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -14,6 +14,8 @@ pt_type:
Constant: 0.9848857801796105
min_soc: 0.05
max_soc: 0.95
aux_supply_eff:
Constant: 1.0
state:
pwr_prop_max_watts: 0.0
pwr_regen_max_watts: 0.0
Expand Down
2 changes: 2 additions & 0 deletions cal_and_val/f3-vehicles/2016 Nissan Leaf 30 kWh.yaml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -14,6 +14,8 @@ pt_type:
Constant: 0.9848857801796105
min_soc: 0.05
max_soc: 0.95
aux_supply_eff:
Constant: 1.0
state:
pwr_prop_max_watts: 0.0
pwr_regen_max_watts: 0.0
Expand Down
2 changes: 2 additions & 0 deletions cal_and_val/f3-vehicles/2016 TESLA Model S60 2WD.yaml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -14,6 +14,8 @@ pt_type:
Constant: 0.9848857801796105
min_soc: 0.05
max_soc: 0.9
aux_supply_eff:
Constant: 1.0
state:
pwr_prop_max_watts: 0.0
pwr_regen_max_watts: 0.0
Expand Down
3 changes: 2 additions & 1 deletion cal_and_val/f3-vehicles/2016 TOYOTA Camry 4cyl 2WD.yaml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -56,6 +56,8 @@ pt_type:
strategy: Linear
extrapolate: Error
pwr_idle_fuel_watts: 0.0
aux_supply_eff:
Constant: 1.0
state:
i: 0
pwr_out_max_watts: 0.0
Expand Down Expand Up @@ -126,7 +128,6 @@ pt_type:
i: []
vehicle_dynamics_prevent_dfco: []
mass_kilograms: ~
alt_eff: 1.0
chassis:
drag_coef: 0.3
frontal_area_square_meters: 2.694
Expand Down
3 changes: 2 additions & 1 deletion cal_and_val/f3-vehicles/2016 TOYOTA Corolla 4cyl 2WD.yaml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -56,6 +56,8 @@ pt_type:
strategy: Linear
extrapolate: Error
pwr_idle_fuel_watts: 0.0
aux_supply_eff:
Constant: 1.0
state:
i: 0
pwr_out_max_watts: 0.0
Expand Down Expand Up @@ -126,7 +128,6 @@ pt_type:
i: []
vehicle_dynamics_prevent_dfco: []
mass_kilograms: ~
alt_eff: 1.0
chassis:
drag_coef: 0.3
frontal_area_square_meters: 2.574
Expand Down
4 changes: 4 additions & 0 deletions cal_and_val/f3-vehicles/2016 TOYOTA Highlander Hybrid.yaml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -14,6 +14,8 @@ pt_type:
Constant: 0.9848857801796105
min_soc: 0.4
max_soc: 0.8
aux_supply_eff:
Constant: 1.0
state:
pwr_prop_max_watts: 0.0
pwr_regen_max_watts: 0.0
Expand Down Expand Up @@ -109,6 +111,8 @@ pt_type:
strategy: Linear
extrapolate: Error
pwr_idle_fuel_watts: 0.0
aux_supply_eff:
Constant: 1.0
state:
i: 0
pwr_out_max_watts: 0.0
Expand Down
Loading
Loading