Skip to content

Commit

Permalink
update readme
Browse files Browse the repository at this point in the history
  • Loading branch information
MeWu-IDM committed Apr 15, 2024
1 parent 767e999 commit c19ad4e
Show file tree
Hide file tree
Showing 2 changed files with 8 additions and 5 deletions.
13 changes: 8 additions & 5 deletions Setup.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,12 +2,15 @@

1. Download [start_pace_ui.bat](https://github.com/InstituteforDiseaseModeling/PACE-HRH-UI/blob/main/start_pace_ui.bat) to your computer. ![](./screenshots/download_batch.png)

2. Double-click on the downloaded file to start the PACE-HRH-UI application. Note: Your computer's antivirus scan may prevent you from running it, click on "More Info" and "Run Anyway" to proceed. ![](./screenshots/defender.png)
2. Double-click on the downloaded file `start_pace_ui.bat` to start the PACE-HRH-UI application installation. Note: Your computer's antivirus scan may prevent you from running it, click on "More Info" and "Run Anyway" to proceed. If this works, please go to step 3.![](./screenshots/defender.png)

3. Alternatively you can use command prompt window to run it. Open a command prompt window (cmd) and navigate to the folder where you downloaded the file. Run the following command: `start_pace_ui.bat` ![](./screenshots/commandline.png)
Alternatively you can use command prompt window to run it. In Windows search bar, type `%windir%\system32\cmd.exe` and click `Open` ![](./screenshots/cmd.png)

4. When you start the application, you will see a command prompt window asking for installation location. You must have internet for the first time installation. (However,You will be able to zip this "installed folder" later and send it to those who do not have internet access for offline run). You can enter either absolute or relative path. All the files needed to run will be installed into this location and you will need to launch the app from this location later. You will also need to agree on our license terms in order to proceed. ![](./screenshots/prompt.png)
This should open a command prompt window (cmd), you can navigate to the folder where you downloaded the file using `CD` command. For example `CD C:\Users\mewu\Downloads` Run the following command: `start_pace_ui.bat` ![](./screenshots/commandline.png)

5. The installation may take 5-10 minutes depending on your computer's processing power and internet speed. Once the installation is completed, you will see it asking you to reopen the `start_pace_ui.bat` from your chosen directory. You can now close the command prompt window and go to this folder, from there you can restart app using the same batch script in offline mode. ![](./screenshots/success.png)
3. When you start the application, you will see a command prompt window asking for installation location. **You must have internet for the first time installation.** (However,You will be able to zip this "installed folder" later and send it to those who do not have internet access for offline run). You can enter either absolute or relative path, the installation process does not accept an existing folder and will create the new folder for you. All the files needed to run will be installed into this location and you will need to launch the app from this location later. **Please write down the path so that you can remember it later.**
**You will also need to agree on our license terms in order to proceed.**![](./screenshots/prompt.png)

6. After restart (double click) `start_pace_ui.bat` from your installed location, it should open the app on port 8888 using your default browser. Leave the commandline window open while interacting with the app. ![](./screenshots/app.png)
4. The installation may take 5-10 minutes depending on your computer's processing power and internet speed. Once the installation is completed, you will see it asking you to reopen the `start_pace_ui.bat` from your chosen directory (The one you wrote down from step 3). You can now close the command prompt window and go to this folder, from there you can launch the app using the `start_pace_ui.bat` in offline mode. ![](./screenshots/success.png)

5. **Make sure to go to folder of your choice from step3, then double click `start_pace_ui.bat` from your installed location**, it should open the app on port 8888 using your default browser. Leave the commandline window open while interacting with the app. ![](./screenshots/app.png)
Binary file added screenshots/cmd.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.

0 comments on commit c19ad4e

Please sign in to comment.