As of the v1.2.0 release the tool does not need to be installed and can be run once unzipped. To begin, unzip the Smart_CO2_Transport_v1.2.0.zip where you would like to use the tool. Browse to the unzipped folder. Inside there will be a Smart_CO2_Transport.exe which you can double click to run the program. A console will open to display the status of the tool's server, and a browser window should open once the tool has finished loading.
The browser window is where the user will interact with the tool. If the browser does not automatically open when the tool is ready or if you would prefer to use a different browser simply type localhost:5000
into the navigation bar of a browser and it should connect to the server as long as the server is still running in the console.
The server window program will be ready when the following lines appear on-screen:
* Running on http://127.0.0.1:5000
Press CTRL+C to quit
During tool operation, the server window will have additional lines of text, these can all be ignored and are information for developers.
The instructions below correspond to the installer model prior to the 1.2 release.
First, install the entire tool by running CO2Pipeline Setup 0.1.0.exe. This can be found in the "Releases" section of this github repository, to the right of this text. Then, open the UI window by running C:\Users[username]\AppData\Local\Programs\apptest\CO2Pipeline.exe, if it's not already open. Then, open the server window by running C:\Users[username]\AppData\Local\Programs\apptest\CO2PRT_Flask.exe. Wait for the server program to initialize, waiting until the line "Press CTRL+C to quit" appears on the screen. Instruction on tool operation can be found by clicking the "Help Documentation" button in the upper-right corner of the UI program window.
Install the pipeline routing tool with "CO2Pipeline Setup 0.1.0.exe"
The installer will automatically handle everything after its clicked on, and when finished will open the UI portion of the tool. This is not the entire tool, and the below steps are required for the tool to function.
Navigate to your AppData folder in your computer. On Windows systems, this can be found at C:\Users[username]\AppData, where [username] is the name of the Windows profile of the computer you are logged into.
Note: The AppData folder may be hidden by default, but can be made visible by clicking the "View" tab and checking the "Hidden items" box at the top of the Windows file browser.
The program needs to have two windows open at the same time to function: the UI window, and the server window.
The UI window program is installed at, and can be opened at:
C:\Users[username]\AppData\Local\Programs\apptest\CO2Pipeline.exe
The server window program is installed at, and can be opened at: C:\Users[username]\AppData\Local\Programs\apptest\CO2PRT_Flask.exe
Open both windows to run the tool. They can be opened in any order.
The server window program will need a minute or two to boot up. During this process, the window will initially be a black screen, and after a few minutes lines of start-up text will appear, starting with:
"Matplotlib is building the font cache; this may take a moment".
The server window program will be ready when the following lines appear on-screen:
* Running on http://127.0.0.1:5000
Press CTRL+C to quit
During tool operation, the server window will have additional lines of text, these can all be ignored and are information for developers.
When both windows are open, and "Press CTRL+C to quit" has appeared on the server window program, the tool is ready for use. Additional details on tool operation can be found by clicking the "Help Documentation" button in the UI window program of the tool.