WSU supply chain resilience (FTOT 2021.1)

README.md

@@ -1,43 +1,38 @@
-# FTOT 
-
-Freight and Fuel Transportation Optimization Tool 
-
-## Description:
-FTOT is a flexible scenario-testing tool that optimizes the transportation of materials for future energy and freight
-scenarios.  FTOT models and tracks commodity-specific information and can take into account conversion  of raw materials to products (e.g., crude oil to jet fuel and diesel) and the fulfillment of downstream demand. FTOT was developed at the US Dept. of Transportation's Volpe National Transportation Systems Center.
-
-## Installation: 
-See [FTOT Installation wiki](https://github.com/VolpeUSDOT/FTOT-Public/wiki/FTOT-Installation-Guide) for the detailed instructions. 
-* FTOT is a python based tool. 
-* Clone or download the repository.
-* Install the required dependencies (including ESRI ArcGIS)
-* Download the [documentation and scenario dataset](https://github.com/VolpeUSDOT/FTOT-Public/wiki/Documentation-and-Scenario-Datasets)
-
-## Usage:
-* Usage is explained in the Quick Start documentation here: [Documentation and Scenario Dataset Wiki](https://github.com/VolpeUSDOT/FTOT-Public/wiki/Documentation-and-Scenario-Datasets)
-
-## Contributing: 
-* Add bugs and feature requests to the Issues tab for the Volpe Development Team to triage.
-
-## Credits: 
-* Dr. Kristin Lewis (Volpe) <[email protected]>
-* Matthew Pearlson (Volpe) <[email protected]> 
-* Alexander Oberg (Volpe) 
-* Olivia Gillham (Volpe) 
-* Gary Baker (Volpe) 
-* Dr. Scott B. Smith (Volpe) 
-* Amy Vogel (Volpe)
-* Amro El-Adle (Volpe)
-* Kirby Ledvina (Volpe)
-* Kevin Zhang (Volpe)
-* Michelle Gilmore (Volpe) 
-* Mark Mockett (iBiz)
-
-## Project Sponsors:
-The development of FTOT that contributed to this public version was funded by the U.S. Federal Aviation Administration (FAA) Office of Environment and Energy and the Department of Defense (DOD) Office of Naval Research through Interagency Agreements (IAA) FA4SCJ and FB48CS under the supervision of FAA’s Nathan Brown and by the U.S. Department of Energy (DOE) Office of Policy under IAA VXS3A2 under the supervision of Zachary Clement. Any opinions, findings, conclusions or recommendations expressed in this material are those of the authors and do not necessarily reflect the views of the FAA nor of DOE.
-
-## Acknowledgements:
-The FTOT team thanks our Beta testers and collaborators for valuable input during the FTOT Public Release beta testing, including Dane Camenzind, Kristin Brandt, and Mike Wolcott (Washington State University), Mik Dale (Clemson University), Emily Newes and Ling Tao (National Renewable Energy Laboratory), Seckin Ozkul, Robert Hooker, and George Philippides (Univ. of South Florida), and Chris Ringo (Oregon State University).
-
-## License: 
-This project is licensed under the terms of the FTOT End User License Agreement. Please read it carefully.
+# Forest Residuals-to-Jet Fuel Supply Chain Documentation (2021.1 Version)
+
+
+Created by WSU, 
+Jie Zhao (Graduate Research Assistant, Washington State University, Pullman, WA 99164, USA, E-mail: [email protected]);
+Ji Yun Lee (Assistant Professor, Washington State University, Pullman, WA 99164, USA, E-mail: [email protected])
+
+## Overview: 
+Supply chain resilience assessment includes two parts: integrated risk assessment to capture the combined effects of multiple risk factors on supply chain performance, and resilience assessment to calculate the long-term supply chain resilience in planning horizon. 
+The purpose of this documentation is to illustrate how to run the Forest Residuals-to-Jet Fuel supply chain resilience assessment based on FTOT optimization and several outputs from risk assessment. 
+
+## Getting Started:
+(a) Forest Residuals-to-Jet Fuel supply chain scenario is stored C:\FTOT_SCR\scenarios\ForestResiduals_SCR folder. 
+(b) Download the common_data folder from the FTOT dataset and save it into C:\FTOT_SCR/scenarios folder.
+(c) ArcGIS 64‐bit background geoprocessing is required to run this scenario due to the large computational burden.
+(d) The batch script file (run_v5_ 1.bat) is included in the ForestResiduals_SCR folder to automate each step required in FTOT optimization.
+
+## ForestResiduals_SCR folder includes:
+(a) scenario configuration file (scenario.XML): to define the locations of the files and parameter values used in the run.
+(b) the batch script file (run_v5_ 1.bat): to execute FTOT run in a sequence of steps.
+(c) input_data folder: to record facility-related data and each facility type has a separate CSV file.
+(d) input_GISdata folder: to contain a facilities.gdb file.
+(e) 1- to 6- Python files: to simulate the effects of risk factors on supply chain performance (risk assessment).
+(f) CSV and TXT files: to present all inputs data into 1- to 6- Python files for risk assessment. 
+
+## Run Step:
+(a) Go to FTOT_SCR\scenarios\ForestResiduals_SCR folder.
+(b) Risk assessment: run 1- to 6- Python files in sequence, and then the outputs can be used into modified FTOT optimization run.
+(c) Resilience assessment: run the batch script by double-clicking it or manually executing it in the Command Prompt.
+
+## Run Scenario:
+(a) Informational logging is available in the ForestResiduals_SCR\logs folder.
+(b) Optimization steps would be iterated for each scenario and time period. 
+(c) Each optimization should run take about 10 minutes, the total simulation will take about 20 days.
+
+## Results:
+(a) Final result (supply chain resilience for every scenario) is save into a NPY file, called Resilience.npy.
+(b) Related results, such as resilience components, weight factors for each component, are saved in associated NPY files.