Merge pull request #84 from NatLabRockies/t3co-2.0

T3co 2.0

Author: harish-panneerselvam

.env.example

@@ -0,0 +1,10 @@
+# EIA Open Data API key (required for zipcode-based fuel price lookups)
+# Register at https://www.eia.gov/opendata/register.php
+# When a US zipcode is set in the Config region column, T3CO auto-discovers
+# the latest AEO publication year and fetches region-specific fuel prices.
+T3CO_EIA_API_KEY=your_api_key_here
+
+# SSL verification for EIA API requests.
+# Set to "false" to disable (e.g. behind a corporate proxy with SSL inspection),
+# or set to a path to a custom CA bundle file.
+# T3CO_SSL_VERIFY=false

.github/workflows/python-publish.yml

@@ -21,38 +21,47 @@ jobs:
     strategy:
       fail-fast: false
       matrix:
-        python-version: ["3.8", "3.9", "3.10"]
+        python-version: ["3.9", "3.10", "3.11", "3.12", "3.13"]
 
     steps:
-      - uses: actions/checkout@v1
+      - uses: actions/checkout@v4
         with:
           fetch-depth: 9
           submodules: false
 
       - name: Use Python ${{ matrix.python-version }}
-        uses: actions/setup-python@v4
+        uses: actions/setup-python@v5
         with:
           python-version: ${{ matrix.python-version }}
 
-      - name: Install dependencies
-        run: |
-          pip install -r requirements.txt
+      - name: Install local package
+        run: pip install .
+
+      - name: Install fastsim extra (Python 3.9–3.10 only)
+        if: ${{ matrix.python-version == '3.9' || matrix.python-version == '3.10' }}
+        run: pip install "fastsim>=2.1.1,<3"
 
+      - name: Install test dependencies
+        run: pip install pytest pytest-mock
+
+      - name: Run tests
+        run: pytest
+
+      # Build the distribution only on Python 3.10.
       - name: Install distribution dependencies
-        run: |
-          pip install build
-        if: matrix.python-version == 3.10
+        if: ${{ matrix.python-version == '3.10' }}
+        run: pip install build
 
       - name: Create distribution package
+        if: ${{ matrix.python-version == '3.10' }}
         run: python -m build
-        if: matrix.python-version == 3.10
 
       - name: Upload distribution package
+        if: ${{ matrix.python-version == '3.10' }}
         uses: actions/upload-artifact@v4
         with:
           name: dist
           path: dist
-        if: matrix.python-version == 3.10
 
   publish:
     runs-on: ubuntu-latest
@@ -66,24 +75,26 @@ jobs:
           path: dist
 
       - name: Use Python 3.12
-        uses: actions/setup-python@v1
+        uses: actions/setup-python@v5
         with:
           python-version: '3.12'
 
       - name: Install dependencies
-        run: |
-          pip install twine
+        run: pip install twine
 
       - name: Publish distribution 📦 to Test PyPI
-        run: |
-          twine upload -r testpypi dist/*
+        run: twine upload -r testpypi dist/*
         env:
           TWINE_USERNAME: __token__
           TWINE_PASSWORD: ${{ secrets.test_pypi_password }}
 
-      - name: Publish distribution 📦 to PyPI
+      - name: Install t3co from Test PyPI and run tests
         run: |
-          twine upload -r pypi dist/*
+          pip install --upgrade --no-cache-dir --index-url https://test.pypi.org/simple/ t3co[dev]
+          pytest
+
+      - name: Publish distribution 📦 to PyPI
+        run: twine upload -r pypi dist/*
         env:
           TWINE_USERNAME: __token__
           TWINE_PASSWORD: ${{ secrets.pypi_password }}

.gitignore

@@ -6,10 +6,11 @@
 *.docx
 *.pdf
 *.svg
+!docs/images/*.svg
 !docs/t3co_logo.svg
 *.csv
-!t3co/resources/inputs/**/*.csv
-!t3co/**/*.csv
+!src/t3co/resources/*.csv
+!src/t3co/**/*.csv
 *.xlsx
 *.json
 *.txt
@@ -27,6 +28,11 @@
 *.Rhistory
 *venv*
 *.DS_Store
+.env
+t3co/resources/T3CO_Config_Local.csv
 /site
-/t3co/resources/auxiliary/payload_pdf.csv
-/t3co/tco_results
+/tco_results
+/src/t3co/resources/auxiliary/payload_pdf.csv
+/src/results
+/src/t3co/resources/results
+!/src/t3co/resources/cost_toggles.json

MANIFEST.in

@@ -0,0 +1 @@
+recursive-include t3co/resources *

Makefile

@@ -1,69 +1,162 @@
 
 ![t3co_logo](https://github.com/user-attachments/assets/60623b62-57de-4475-b839-d7eb39405185)
 
-[![homepage](https://img.shields.io/badge/homepage-t3co-blue)](https://www.nrel.gov/transportation/t3co.html) [![github](https://img.shields.io/badge/github-t3co-blue.svg)](https://github.com/NREL/T3CO) [![documentation](https://img.shields.io/badge/documentation-t3co-blue.svg)](https://nrel.github.io/T3CO/) [![PyPI - Version](https://img.shields.io/pypi/v/t3co)](https://pypi.org/project/t3co/) ![GitHub License](https://img.shields.io/github/license/NREL/T3CO) ![PyPI - Python Version](https://img.shields.io/pypi/pyversions/t3co) 
+[![homepage](https://img.shields.io/badge/homepage-t3co-blue)](https://www.nlr.gov/transportation/t3co.html) [![github](https://img.shields.io/badge/github-t3co-blue.svg)](https://github.com/NatLabRockies/T3CO) [![documentation](https://img.shields.io/badge/documentation-t3co-blue.svg)](https://NatLabRockies.github.io/T3CO/) [![PyPI - Version](https://img.shields.io/pypi/v/t3co)](https://pypi.org/project/t3co/) ![GitHub License](https://img.shields.io/github/license/NLR/T3CO) ![PyPI - Python Version](https://img.shields.io/pypi/pyversions/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)
+**New to 2.0?** See [What's New in T3CO 2.0](./docs/whats_new.md) for a summary of EIA fuel price integration, expanded optimization algorithms, and other changes.
 
-For information on the T3CO models, go to the [Overview](https://github.com/NREL/T3CO/blob/main/docs/T3CO_Overview.md)
+To get started, read the [Quick Start Guide](./docs/quick_start.md)
+
+For detailed installation instructions, read the [Installation Guide](./docs/installation.md)
+
+For information on the T3CO models, go to the [Overview](./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.
+**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.
 
 ## 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/)
+
+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.
+
+### Installation 'Extras'
+
+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](https://pypi.org/project/t3co/)
+
+After creating a version-appropriate [Python environment](./docs/installation.md#setting-up-env), the latest release of T3CO can be installed from PyPI using one of the following commands.
+
+For the default option/extra:
+
 ```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.
+For the FASTSim-integrated 'extra':
+
+```bash
+pip install t3co[fastsim]
+```
+
+For the developer 'extra':
+
+```bash
+pip install t3co[dev]
+```
+
+### Installation Source #2: Cloning the [GitHub Repo](https://github.com/NatLabRockies/T3CO)
+
+T3CO can also be installed from a clone of the GitHub repository.
+
+First, [clone](https://git-scm.com/docs/git-clone) the repository from [GitHub](https://github.com/NatLabRockies/T3CO) from your desired directory (eg., /Users/Projects/):
+
+```bash
+git clone https://github.com/NatLabRockies/T3CO.git T3CO
+```
+
+This creates a git compliant folder 'T3CO' (i.e., a '/Users/Projects/T3CO' folder)
+
+To access the `t3co-2.0` branch,
 
-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
+git checkout t3co-2.0
 ```
 
-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:
+From within the [Python environment](./docs/installation.md#setting-up-env), navigate to the parent directory containing the T3CO repository (`cd T3CO`) and run one of these three installation options:
+
+
+For the default option/extra:
+
 ```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).
+
+For the FASTSim-integrated 'extra':
+
+```bash
+pip install -e .[fastsim]
+```
+
+For the developer 'extra':
+
+```bash
+pip install -e .[dev]
+```
 
 ### 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:
+The [`t3co.resources`](./src/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:
 ```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)
+More information on the demo input files can be found in the [Installation Guide](./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:
+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:
 
 ```bash
-python -m t3co.sweep --analysis-id=0 --config=<path/to/T3COConfig.csv>
+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 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`).
+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](./docs/quick_start.md)
 
-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)
+### EIA Fuel Price Projections
+
+T3CO can fetch fuel price projections directly from the [EIA Annual Energy Outlook (AEO)](https://www.eia.gov/outlooks/aeo/) API instead of relying on the static `FuelPrices.csv` file. When a US zipcode is provided in the `region` column of the Config file (or in the Scenario file), T3CO automatically:
+
+1. Discovers the **latest** AEO publication year available from the EIA API (e.g. AEO 2025)
+2. Identifies the **reference case** scenario for that year
+3. Resolves the zipcode to the corresponding **US Census division** (e.g. `90210` → Pacific)
+4. Fetches region-specific fuel price projections for diesel, gasoline, electricity, and CNG
+5. Falls back to `FuelPrices.csv` for hydrogen (not available in AEO)
+
+To enable this feature:
+
+1. Register for a free API key at [eia.gov/opendata/register.php](https://www.eia.gov/opendata/register.php)
+2. Create a `.env` file in your project root (see `.env.example`):
+   ```
+   T3CO_EIA_API_KEY=your_api_key_here
+   ```
+3. Set the `region` column in `T3COConfig.csv` to a US zipcode (e.g. `90210`)
+4. Ensure the `eia_fuel_prices` toggle is enabled in `cost_toggles.json` (default: `true`)
+
+To pin a specific AEO year instead of using the latest, set `eia_aeo_year` and `eia_aeo_case` in the Config CSV or via CLI:
+```bash
+python -m t3co.cli.sweep --analysis-id=5 --eia-aeo-year=2023 --eia-aeo-case=aeo2022ref
+```
+
+If no zipcode is provided or the toggle is disabled, T3CO uses the static `FuelPrices.csv` as before.
+
+Fuel price override workflows that use `--fuel-prices-json` and `--fuel-prices-zipcode` resolve the source fuel-price region from the installed `zipcodes` dependency instead of repository-maintained ZIP range tables.
 
 ## 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)
+DOE NLR 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.*
+*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/NatLabRockies/T3CO. https://doi.org/10.11578/dc.20240806.4.*
+
+
+## Contact Us
+To reach out to the NLR developer team with feedback, feature requests, or to explore partnership opportunities, please email at [T3CO@nlr.gov](mailto:T3CO@nlr.gov)
 
+This tool is developed and maintained by the Commercial Vehicle Technologies (CVT) team in NLR's Center for Integrated Mobility Sciences.