t3co-go 0.1.3
A web-based dashboard for NREL's Transportation Technology Total Cost of Ownership (T3CO) tool
License: BSD-3-Clause
Requires Python: <3.11,>=3.9
Keywords: tco, vehicle-cost, total-cost, vehicle-simulation, total-cost-of-ownership

[![homepage](https://img.shields.io/badge/homepage-t3co_go-blue)](https://www.nrel.gov/transportation/t3co.html) [![github](https://img.shields.io/badge/github-t3co_go-blue.svg)](https://github.com/NREL/T3CO_Go) [![documentation](https://img.shields.io/badge/documentation-t3co_go-blue.svg)](https://nrel.github.io/T3CO_Go/) [![PyPI - Version](https://img.shields.io/pypi/v/t3co-go)](https://pypi.org/project/t3co-go/) ![GitHub License](https://img.shields.io/github/license/NREL/T3CO_Go) ![PyPI - Python Version](https://img.shields.io/pypi/pyversions/t3co-go)

# T3CO-Go

This repo contains a web-based dashboard called T3CO-Go for NREL's [Transportation Technology Total Cost of Ownership tool, T3CO](https://nrel.github.io/T3CO/).

## Installation

For detailed instructions for setting up enviroment and other prerequisites  to [Installation Guide](https://github.com/NREL/T3CO_Go/blob/main/docs/installation.md)

T3CO-Go can be installed from two sources: PyPI or GitHub

### Installation Source #1: PyPI

From within the [Python environment](https://github.com/NREL/T3CO_Go/blob/main/docs/installation.md#setting-up-env), navigate to the parent directory containing the T3CO repository (`cd T3CO_Go`) and run:

```bash
pip install t3co-go
install_demo_inputs
```

This installs the tool from PyPI and copies T3CO demo input files to the current folder

### Installation Source #2: From a git clone of the repository

T3CO-Go can also be installed from a clone of the [GitHub repository](https://github.com/NREL/T3CO_Go).

First, [clone](https://git-scm.com/docs/git-clone) the repository from [GitHub](https://github.com/NREL/T3CO_Go) from your desired directory (eg., /Users/Projects/):

```bash
git clone https://github.com/NREL/T3CO_Go.git T3CO_Go
```

This creates a git compliant folder 'T3CO_Go' (i.e., a '/Users/Projects/T3CO_Go' folder)

From within the [Python environment](https://github.com/NREL/T3CO_Go/blob/main/docs/installation.md#setting-up-env), navigate to the parent directory containing the T3CO repository (`cd T3CO_Go`) and run this command:

```bash
pip install -e .
install_demo_inputs
```

This installs the tool from the repo clone and copies T3CO demo input files to the same folder

## Quick Start

Go to [Quick Start Guide](https://github.com/NREL/T3CO_Go/blob/main/docs/quick_start.md)

## Starting a T3CO-Go instance

After installing T3CO-Go within a Python environment using one of the two sources, run this command:

```bash
run_t3co_go
```

This will open a web browser tab with T3CO prepared to run on your local machine in the background.

## 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-25-38

## Contact Us

To reach out to the NREL developer team with feedback, feature requests, or to explore partnership opportunities, please email at [T3CO@nrel.gov](mailto:T3CO@nrel.gov)

This tool is developed and maintained by the Commercial Vehicle Technologies (CVT) team in NREL's Center for Integrated Mobility Sciences.