Start the program

After the installation of the dependencies, users can follow the steps below to start the tool.

Preparation

1. Open powershell or terminal

   On Windows

   Users need to find or search Anaconda Powershell Prompt (miniconda3) and then open it.

   On Linux/macOS

   Users need to find or search Terminal and then open it.

2. [Optional] If users have set a PanGraphViewer environment, users need to activate the env by using

   conda activate PanGraphViewer
   

Desktop-based version

On Windows

• If users have put panGraphViewer on Desktop, users can start the program like

cd C:\Users\%USERNAME%\Desktop\panGraphViewer\panGraphViewerApp
python panGraphViewerApp.py

• If users have put panGraphViewer on another drive, users may need to move to the target drive first. For instance, the target drive is D, users can move to the drive by typing D: in Anaconda Prompt (miniconda3) and press Enter first and then move to the panGraphViewerApp directory to execute by typing

D:
cd panGraphViewer\panGraphViewerApp
python panGraphViewerApp.py

On Linux/macOS

Users may use the command line below in Terminal to open the software

cd /full/path/to/panGraphViewer/panGraphViewerApp ## Please modify the path based on your ENV
python panGraphViewerApp.py

NOTE:

1. On Windows systems, users need to use backslash \ rather than the common slash / to go to the target directory.
2. The logging information will show in Anaconda Prompt (miniconda3) or Terminal depending on the system used

Web browser-based version

On Windows

• If users have put panGraphViewer on Desktop, users can start the program like

cd C:\Users\%USERNAME%\Desktop\panGraphViewer\panGraphViewerWeb
run.bat

• If users have put panGraphViewer on another drive, users may need to move to the target drive first. For instance, the target drive is D, users can move to the drive by typing D: in Anaconda Prompt (miniconda3) and press Enter first and then move to the panGraphViewerApp directory to execute by typing

D:
cd panGraphViewer\panGraphViewerWeb
run.bat

On Linux/macOS

Users may use the command line below in Terminal to open the software

cd /full/path/to/panGraphViewer/panGraphViewerWeb ## Please modify the path based on your ENV
bash run.sh

NOTE:

1. Once the words Starting development server at http://0.0.0.0:8000/ or similar information is showing in the Terminal or Anaconda Prompt (miniconda3), users can open a browser to open the web-based panGraphViewer. For local machine, users can type localhost:8000 in the browser to open panGraphViewer.
2. The test account is demo and the password is demodemo.
3. The admin page is something like http://localhost:8000/admin depending on the IP used and the initial admin account is admin and the password is abcd1234
4. Please use the go back button provided by the web browser to move back rather than directly clicking the corresponding functions in the web page to perform analyses.
5. We have provided a docker image for the web-based PanGraphViewer, users would follow the steps to install and run the program