This documentation repo is intended for beta-testers of the t3co-2.0 branch and will be taken down after the full release of T3CO v2.0.0
This repo houses T3CO (Transportation Technology Total Cost of Ownership), software for modeling total cost of ownership for commercial vehicles with advanced powertrains.
To get started, read the Quick Start Guide
For detailed installation instructions, read the Installation Guide
For information on the T3CO models, go to the Overview
T3CO is a general framework allowing a user to determine the total cost of ownership (TCO) of a vehicle (sometimes a FASTSim vehicle model paired with drivecycle(s) for determining fuel efficiency). The user can also determine performance of gradeability, acceleration, and range. In addition to straight TCO computation there is also the option to optimize a vehicle powertrain such that it meets performance optional targets while also optionally minimizing TCO.
T3CO is available on PyPI and as a public access GitHub repository. This gives the user two sources from where T3CO Python Package can be obtained and installed.
The user can choose one of three installation options or 'extras' of T3CO based on their desired tool capabilities.
- T3CO as a pure cost estimation tool with exogenous inputs (default version
t3co- requires Python>=3.9, <=3.13) - T3CO integrated with FASTSim for energy simulation (
t3co[fastsim], requires Python>=3.9,<=3.10) - T3CO for developers and quality testers that includes all capabilities (
t3co[dev]requires Python>=3.9,<=3.10) The different 'extras' refers to different sets of dependencies that get installed along with T3CO.
Installation Source #1: From PyPI
After creating a version-appropriate Python environment, the latest release of T3CO can be installed from PyPI using one of the following commands.
For the default option/extra:
pip install t3coFor the FASTSim-integrated 'extra':
pip install t3co[fastsim]For the developer 'extra':
pip install t3co[dev]Installation Source #2: Cloning the GitHub Repo
T3CO can also be installed from a clone of the GitHub repository.
First, clone the repository from GitHub from your desired directory (eg., /Users/Projects/):
git clone https://github.com/NREL/T3CO.git T3COThis creates a git compliant folder 'T3CO' (i.e., a '/Users/Projects/T3CO' folder)
To access the t3co-2.0 branch,
git checkout t3co-2.0From within the Python environment, navigate to the parent directory containing the T3CO repository (cd T3CO) and run one of these three installation options:
For the default option/extra:
pip install -e .For the FASTSim-integrated 'extra':
pip install -e .[fastsim]For the developer 'extra':
pip install -e .[dev]The t3co.resources module folder contains all the necessary input files needed for running T3CO. To get an offline copy of this folder in your preferred directory, run:
install_t3co_demo_inputsMore information on the demo input files can be found in the Installation Guide
T3CO needs three main input files (Vehicles, Scenarios, and Config) to run an analysis. The analysis settings, file paths to main and auxiliary input files, and other parameter overrides are saved as an entry on the Config file. The user is provided with 500+ Vehicle-Scenario pairs inputs and four Config sample analyses to choose from to modify parameters and/or run their first T3CO analysis. The main module for T3CO,t3co.cli.sweep, can be run using:
python -m t3co.cli.sweep --analysis-id=0 --config=<path/to/T3COConfig.csv>Point the --config argument to the T3COConfig.csv file path (either the src/t3co/resource/T3COConfig.csv file in a repo clone or the demo_inputs/T3COConfig.csv file after copying the demo input files. This parameter defaults to the T3COConfig.csv file in the t3co.resources module) and --analysis-id to the desired config.analysis_id (either an existing row or a newly added "Analysis" row in the T3COConfig.csv file. Default = 0).
Additional information on the inputs, the Batch Mode feature, other CLI arguments, and description of T3CO results are mentioned in the Quick Start Guide
This tool was developed with funding support from the US Department of Energy's Office of Energy Efficiency and Renewable Energy (EERE)'s Vehicle Technology Office.
DOE NREL Software Record: SWR-21-54
Lustbader, Jason, Panneer Selvam, Harish, Bennion, Kevin, Payne, Grant, Hunter, Chad, Penev, Michael, Brooker, Aaron, Baker, Chad, Birky, Alicia, Zhang, Chen, and Carow, Kyle. "T3CO (Transportation Technology Total Cost of Ownership) Open Source [SWR-21-54]." Computer software. September 16, 2024. https://github.com/NREL/T3CO. https://doi.org/10.11578/dc.20240806.4.
To reach out to the NREL developer team with feedback, feature requests, or to explore partnership opportunities, please email at T3CO@nrel.gov
This tool is developed and maintained by the Commercial Vehicle Technologies (CVT) team in NREL's Center for Integrated Mobility Sciences.