| Name | t3co JSON |
| Version |
1.0.10
JSON |
| download |
| home_page | None |
| Summary | NREL's Transportation Technology Total Cost of Ownership tool |
| upload_time | 2024-11-21 06:36:50 |
| maintainer | None |
| docs_url | None |
| author | None |
| requires_python | >=3.8 |
| license | BSD 3-Clause License Copyright (c) 2024, Alliance for Sustainable Energy, LLC Redistribution and use in source and binary forms, with or without modification, are permitted provided that the following conditions are met: 1. Redistributions of source code must retain the above copyright notice, this list of conditions and the following disclaimer. 2. Redistributions in binary form must reproduce the above copyright notice, this list of conditions and the following disclaimer in the documentation and/or other materials provided with the distribution. 3. Neither the name of the copyright holder nor the names of its contributors may be used to endorse or promote products derived from this software without specific prior written permission. THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. |
| keywords |
tco
total-cost
total-cost-of-ownership
vehicle-cost
vehicle-simulation
|
| VCS |
 |
| bugtrack_url |
|
| requirements |
No requirements were recorded.
|
| Travis-CI |
No Travis.
|
| coveralls test coverage |
No coveralls.
|
[](https://www.nrel.gov/transportation/t3co.html) [](https://github.com/NREL/T3CO) [](https://nrel.github.io/T3CO/) [](https://pypi.org/project/t3co/)  
# **T3CO** : Transportation Technology Total Cost of Ownership Tool
## Description
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](https://github.com/NREL/T3CO/blob/main/docs/quick_start.md)
For information on the T3CO models, go to the [Overview](https://github.com/NREL/T3CO/blob/main/docs/T3CO_Overview.md)
## Usage
**T3CO** is a general framework allowing a user to determine the total cost of ownership (TCO) of a FASTSim vehicle (paired with a FASTSim 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.
## Installation
T3CO is available on PyPI and as a public access GitHub repository. This gives the user two ways of installing the T3CO Python Package.
### 1. Installing From [PyPI](https://pypi.org/project/t3co/)
```bash
pip install t3co
```
### 2. Cloning the [GitHub Repo](https://github.com/NREL/T3CO)
T3CO can also be installed directly from a clone of the GitHub repository which makes it easier to access input files and run the tool using a Command Line Interface.
First, [clone](https://git-scm.com/docs/git-clone) the repository from [GitHub](https://github.com/NREL/T3CO) from your desired directory:
```bash
git clone https://github.com/NREL/T3CO.git T3CO
```
From within the [Python environment](./docs/installation.md#setting-up-env), navigate to the parent directory containing the T3CO repository (e.g. `cd GitHub/T3CO/`) and run:
```bash
pip install -e .
```
This installs the local version of the T3CO clone along with all its [dependencies](https://github.com/NREL/T3CO/blob/main/requirements.txt).
### Copying the Demo Input Files
The [`t3co.resources`](https://github.com/NREL/T3CO/tree/main/t3co/resources) folder contains all the necessary input files needed for running T3CO. To get an offline copy of this folder in your preferred directory, run:
```bash
install_t3co_demo_inputs
```
More information on the demo input files can be found in the [Installation Guide](https://github.com/NREL/T3CO/blob/main/docs/installation.md#copy-demo-inputs)
## Running T3CO
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.sweep`, can be run using:
```bash
python -m t3co.sweep --analysis-id=0 --config=<path/to/T3COConfig.csv>
```
Point the `--config` argument to the `T3COConfig.csv` file path (either the 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](https://github.com/NREL/T3CO/blob/main/docs/quick_start.md)
## Acknowledgements
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](https://doi.org/10.11578/dc.20240806.4)
## To cite T3CO
*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.*
Raw data
{
"_id": null,
"home_page": null,
"name": "t3co",
"maintainer": null,
"docs_url": null,
"requires_python": ">=3.8",
"maintainer_email": "NREL-AVCI <t3co@nrel.gov>",
"keywords": "tco, total-cost, total-cost-of-ownership, vehicle-cost, vehicle-simulation",
"author": null,
"author_email": "Harish Panneer Selvam <Harish.PanneerSelvam@nrel.gov>, Alicia Birky <Alicia.Birky@nrel.gov>, Chad Baker <Chad.Baker@nrel.gov>",
"download_url": "https://files.pythonhosted.org/packages/d6/df/c875c833e25450daf6bc26e2373c402740105e635a30bbc7ee78854277fb/t3co-1.0.10.tar.gz",
"platform": null,
"description": "\n\n\n[](https://www.nrel.gov/transportation/t3co.html) [](https://github.com/NREL/T3CO) [](https://nrel.github.io/T3CO/) [](https://pypi.org/project/t3co/)   \n\n\n# **T3CO** : Transportation Technology Total Cost of Ownership Tool\n## Description\n\nThis repo houses T3CO (Transportation Technology Total Cost of Ownership), software for modeling total cost of ownership for commercial vehicles with advanced powertrains.\n\nTo get started, read the [Quick Start Guide](https://github.com/NREL/T3CO/blob/main/docs/quick_start.md)\n\nFor information on the T3CO models, go to the [Overview](https://github.com/NREL/T3CO/blob/main/docs/T3CO_Overview.md)\n\n## Usage\n\n**T3CO** is a general framework allowing a user to determine the total cost of ownership (TCO) of a FASTSim vehicle (paired with a FASTSim 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.\n\n## Installation\nT3CO is available on PyPI and as a public access GitHub repository. This gives the user two ways of installing the T3CO Python Package.\n### 1. Installing From [PyPI](https://pypi.org/project/t3co/)\n```bash\npip install t3co\n```\n\n### 2. Cloning the [GitHub Repo](https://github.com/NREL/T3CO)\nT3CO can also be installed directly from a clone of the GitHub repository which makes it easier to access input files and run the tool using a Command Line Interface.\n\nFirst, [clone](https://git-scm.com/docs/git-clone) the repository from [GitHub](https://github.com/NREL/T3CO) from your desired directory:\n```bash\ngit clone https://github.com/NREL/T3CO.git T3CO\n```\n\nFrom within the [Python environment](./docs/installation.md#setting-up-env), navigate to the parent directory containing the T3CO repository (e.g. `cd GitHub/T3CO/`) and run:\n```bash\npip install -e .\n```\nThis installs the local version of the T3CO clone along with all its [dependencies](https://github.com/NREL/T3CO/blob/main/requirements.txt).\n\n### Copying the Demo Input Files\nThe [`t3co.resources`](https://github.com/NREL/T3CO/tree/main/t3co/resources) folder contains all the necessary input files needed for running T3CO. To get an offline copy of this folder in your preferred directory, run:\n```bash\ninstall_t3co_demo_inputs\n```\n\nMore information on the demo input files can be found in the [Installation Guide](https://github.com/NREL/T3CO/blob/main/docs/installation.md#copy-demo-inputs)\n\n\n## Running T3CO\nT3CO 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.sweep`, can be run using:\n\n```bash\npython -m t3co.sweep --analysis-id=0 --config=<path/to/T3COConfig.csv>\n```\n\nPoint the `--config` argument to the `T3COConfig.csv` file path (either the 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`).\n\nAdditional information on the inputs, the Batch Mode feature, other CLI arguments, and description of T3CO results are mentioned in the [Quick Start Guide](https://github.com/NREL/T3CO/blob/main/docs/quick_start.md)\n\n## Acknowledgements\nThis 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.\n\nDOE NREL Software Record: [SWR-21-54](https://doi.org/10.11578/dc.20240806.4)\n\n## To cite T3CO\n\n*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.*\n\n",
"bugtrack_url": null,
"license": "BSD 3-Clause License Copyright (c) 2024, Alliance for Sustainable Energy, LLC Redistribution and use in source and binary forms, with or without modification, are permitted provided that the following conditions are met: 1. Redistributions of source code must retain the above copyright notice, this list of conditions and the following disclaimer. 2. Redistributions in binary form must reproduce the above copyright notice, this list of conditions and the following disclaimer in the documentation and/or other materials provided with the distribution. 3. Neither the name of the copyright holder nor the names of its contributors may be used to endorse or promote products derived from this software without specific prior written permission. THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS \"AS IS\" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.",
"summary": "NREL's Transportation Technology Total Cost of Ownership tool",
"version": "1.0.10",
"project_urls": {
"Bug Tracker": "https://github.com/NREL/T3CO/issues",
"Documentation": "https://nrel.github.io/T3CO",
"Homepage": "https://www.nrel.gov/transportation/t3co.html",
"Repository": "https://github.com/NREL/T3CO"
},
"split_keywords": [
"tco",
" total-cost",
" total-cost-of-ownership",
" vehicle-cost",
" vehicle-simulation"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "77fad627f3670a552bfc424981ac0b0ebb1c50c3b3d433e4dd2ed755fd204b2d",
"md5": "1bd3b11d29ed6c8921d1b3b26c3ea599",
"sha256": "42556df60546db2ab2ba1bef525ddb8bcbc419aac332e7977d6ecc675866af8a"
},
"downloads": -1,
"filename": "t3co-1.0.10-py3-none-any.whl",
"has_sig": false,
"md5_digest": "1bd3b11d29ed6c8921d1b3b26c3ea599",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.8",
"size": 4545433,
"upload_time": "2024-11-21T06:36:48",
"upload_time_iso_8601": "2024-11-21T06:36:48.412292Z",
"url": "https://files.pythonhosted.org/packages/77/fa/d627f3670a552bfc424981ac0b0ebb1c50c3b3d433e4dd2ed755fd204b2d/t3co-1.0.10-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "d6dfc875c833e25450daf6bc26e2373c402740105e635a30bbc7ee78854277fb",
"md5": "251097bb84b86a4784b653ecd9c0d030",
"sha256": "0e2d2273ac586d2f9a7c957683f48577d82746134a1e1b30366aa92660e0bb23"
},
"downloads": -1,
"filename": "t3co-1.0.10.tar.gz",
"has_sig": false,
"md5_digest": "251097bb84b86a4784b653ecd9c0d030",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.8",
"size": 4661596,
"upload_time": "2024-11-21T06:36:50",
"upload_time_iso_8601": "2024-11-21T06:36:50.584495Z",
"url": "https://files.pythonhosted.org/packages/d6/df/c875c833e25450daf6bc26e2373c402740105e635a30bbc7ee78854277fb/t3co-1.0.10.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-11-21 06:36:50",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "NREL",
"github_project": "T3CO",
"travis_ci": false,
"coveralls": false,
"github_actions": true,
"requirements": [],
"lcname": "t3co"
}
