Skip to content
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

12 add documentation to website #13

Merged
merged 5 commits into from
Sep 24, 2024
Merged

12 add documentation to website #13

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
5 commits
Select commit Hold shift + click to select a range
0d8d8d7
Add svg logo and update favicon
panne027 Sep 24, 2024
d928a7c
Update input description md files
panne027 Sep 24, 2024
ad54384
Create t3co_output_parameter_descriptions.md
panne027 Sep 24, 2024
293c237
Remove redundant discounted_tco parameter in sweep
panne027 Sep 24, 2024
12e2137
Add t3co output param descriptions page to mkdocs
panne027 Sep 24, 2024
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
1 change: 1 addition & 0 deletions .gitignore
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -6,6 +6,7 @@
*.docx
*.pdf
*.svg
!docs/t3co_logo.svg
*.csv
!t3co/resources/inputs/**/*.csv
!t3co/**/*.csv
Expand Down
4 changes: 2 additions & 2 deletions docs/config_inputs_descriptions.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,15 +1,15 @@
# Config Input Parameters Descriptions


| Config Input Parameters | Descriptions | Data Formats Accepted |
| **Config Input Parameter** | **Description** | **Data Type(s) Accepted** |
|------------------------------------------|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|-----------------------|
| analysis_id | Index for managing T3CO analyses or runs | int |
| analysis_name | Name of T3CO Analysis for user's reference | string |
| vehicle_file | Filepath to vehicle file relative to /t3co/ folder | string |
| scenario_file | Filepath to scenario file relative to /t3co/ folder | string |
| dst_dir | Filepath to results destination directory | string |
| write_tsv | Boolean switch to save intermediate results files | bool |
| selections | List of selections from vehicle/scenario files to include in the analysis. Takes input as an integer or list of integers. '-1' makes T3CO run all vehicles in the vehicle file | int/list |
| selections | List of selections from vehicle/scenario files to include in the analysis. Takes input as an integer or list of integers. '-1' makes T3CO run all vehicles in the vehicle file | int/list\[int\] |
| vehicle_life_yr | Override number of TCO years for all selections.. If left blank, T3CO uses selection specific vehicle_life_yr from scenario file | int |
| ess_max_charging_power_kw | Override ESS max charging power for all selections. If left blank, T3CO uses selection specific ess_max_charging_power_kw from scenario file | float |
| fs_fueling_rate_kg_per_min | Override gaseous fueling fill rate for all selections. If left blank, T3CO uses selection specific fs_fueling_rate_kg_per_min from scenario file | float |
Expand Down
14 changes: 7 additions & 7 deletions docs/scenario_inputs_descriptions.md
View file
Open in desktop

Large diffs are not rendered by default.

112 changes: 112 additions & 0 deletions docs/t3co_logo.svg
View file
Open in desktop
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
68 changes: 68 additions & 0 deletions docs/t3co_output_parameter_descriptions.md
View file
Open in desktop

Large diffs are not rendered by default.

16 changes: 8 additions & 8 deletions docs/vehicle_inputs_descriptions.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
# Vehicle Input Descriptions

| vehicle parameter | description | data type |
| **Input Parameter Name** | **Description** | **Data Type(s) Accepted** |
|--------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------|----------------|
| scenario_name | Vehicle name |  string |
| selection | Vehicle database ID |  int |
Expand All @@ -13,24 +13,24 @@
| drive_axle_weight_frac | Fraction of weight on the drive axle while stopped |  float |
| wheel_base_m | Wheelbase, $m$ |  float |
| cargo_kg | Cargo mass including passengers, $kg$ |  float |
| veh_override_kg | Total vehicle mass, overrides mass calculation, $kg$ |  Option<float> |
| veh_override_kg | Total vehicle mass, overrides mass calculation, $kg$ (Optional) |  float |
| comp_mass_multiplier | Component mass multiplier for vehicle mass calculation |  float |
| fs_max_kw | Fuel storage max power output, $kW$ |  float |
| fs_secs_to_peak_pwr | Fuel storage time to peak power, $s$ |  float |
| fs_kwh | Fuel storage energy capacity, $kWh$ |  float |
| fs_kwh_per_kg | Fuel specific energy, $\frac{kWh}{kg}$ |  float |
| fc_max_kw | Fuel converter peak continuous power, $kW$ |  float |
| fc_pwr_out_perc | Fuel converter output power percentage map, x values of fc_eff_map |  Array1<float> |
| fc_eff_map | Fuel converter efficiency map |  Array1<float> |
| fc_pwr_out_perc | Fuel converter output power percentage map, x values of fc_eff_map |  list\[float\] |
| fc_eff_map | Fuel converter efficiency map |  list\[float\] |
| fc_eff_type | Fuel converter efficiency type, one of [SI, ATKINSON, DIESEL, H2FC, HD_DIESEL] Used for calculating fc_eff_map, and other calculations if H2FC |  string |
| fc_sec_to_peak_pwr | Fuel converter time to peak power, $s$ |  float |
| fc_base_kg | Fuel converter base mass, $kg$ |  float |
| fc_kw_per_kg | Fuel converter specific power (power-to-weight ratio), $\frac{kW}{kg}$ |  float |
| min_fc_time_on | Minimum time fuel converter must be on before shutoff (for HEV, PHEV) |  float |
| idle_fc_kw | Fuel converter idle power, $kW$ |  float |
| mc_max_kw | Peak continuous electric motor power, $kW$ |  float |
| mc_pwr_out_perc | Electric motor output power percentage map, x values of mc_eff_map |  Array1<float> |
| mc_eff_map | Electric motor efficiency map |  Array1<float> |
| mc_pwr_out_perc | Electric motor output power percentage map, x values of mc_eff_map |  list\[float\] |
| mc_eff_map | Electric motor efficiency map |  list\[float\] |
| mc_sec_to_peak_pwr | Electric motor time to peak power, $s$ |  float |
| mc_pe_kg_per_kw | Motor power electronics mass per power output, $\frac{kg}{kW}$ |  float |
| mc_pe_base_kg | Motor power electronics base mass, $kg$ |  float |
Expand Down Expand Up @@ -64,5 +64,5 @@
| trans_kg | Transmission mass, $kg$ |  float |
| trans_eff | Transmission efficiency |  float |
| ess_to_fuel_ok_error | Maximum acceptable ratio of change in ESS energy to expended fuel energy (used in hybrid SOC balancing), $\frac{\Delta E_{ESS}}{\Delta E_{fuel}}$ |  float |
| fc_peak_eff_override | Fuel converter efficiency peak override, scales entire curve |  Option<float> |
| mc_peak_eff_override | Motor efficiency peak override, scales entire curve |  Option<float> |
| fc_peak_eff_override | Fuel converter efficiency peak override, scales entire curve(Optional) |  float |
| mc_peak_eff_override | Motor efficiency peak override, scales entire curve (Optional) |  float |
4 changes: 3 additions & 1 deletion mkdocs.yml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -21,7 +21,7 @@ markdown_extensions:

theme:
name: material
favicon: t3co_logo.png
favicon: t3co_logo.svg
highlightjs: true
hljs_languages:
- python
Expand All @@ -42,6 +42,8 @@ nav:
- Vehicle: vehicle_inputs_descriptions.md
- Scenario: scenario_inputs_descriptions.md
- Config: config_inputs_descriptions.md
- Results:
- Outputs: t3co_output_parameter_descriptions.md
- Code Reference:
- CodeFlow: CodeFlow.md
- T3CO Modules:
Expand Down
3 changes: 2 additions & 1 deletion t3co/sweep.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -63,7 +63,6 @@
"max0to30secAtGVWRAch": "",
"target_max0to30secAtGVWR": "",
"delta_0to30sec": "",
"discounted_tco": "",
"glider_cost_Dol": "",
"fuel_converter_cost_Dol": "",
"fuel_storage_cost_Dol": "",
Expand All @@ -74,6 +73,8 @@
"msrp_total_Dol": "",
"total_fuel_cost_Dol": "",
"total_maintenance_cost_Dol": "",
"discounted_tco_Dol": "",

}


Expand Down
Loading