Skip to content

Commit

Permalink
Tripoli start instructions
Browse files Browse the repository at this point in the history
  • Loading branch information
noahmclean committed Jun 12, 2024
1 parent 9d36241 commit e206cea
Show file tree
Hide file tree
Showing 6 changed files with 76 additions and 15 deletions.
Binary file added graphics/CommandPromptBlank.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added graphics/CommandPromptWithJava.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added graphics/WindowsFileExplorer.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
13 changes: 1 addition & 12 deletions setup/03-QuickStart.md
Original file line number Diff line number Diff line change
Expand Up @@ -30,20 +30,9 @@ numbering:

The easiest way to start Tripoli is to double-click on the Tripoli .jar file you downloaded. However, depending on your computer's security settings, you might get hassled by some warnings. Here's what to do:

## Mac:

The security settings on your Mac are likely configured so that you get a warning when you try and open an app that you downloaded from the internet. Tripoli is not malware, and we are not secretly downloading your unpublished data -- we have enough of our own! To open Tripoli anyway, open System Settings (the gear icon on your dock), then click on "Privacy and Security" in the left-hand menu. Scroll down on the right-hand side of the window until you see a prompt asking if you want to "Open Anyway".

```{image} ../graphics/MacPrivacyAndSecuritySettings.png
:alt: Mac Privacy and Security Settings
:width: 400px
:align: center
```{include} 99-MacSecuritySettings.md
```

Click the "Open Anyway" button, enter your password if needed, and the Tripoli application will open.

You only need to go to Privacy and Security settings once to open this .jar file. Double-clicking on it in the future will just open Tripoli. However, when you download a new version of Tripoli with a new version number and filename, you'll need to repeat the process. Or, you can open Tripoli from the command line using the instructions in the [Starting Tripoli](../using_Tripoli/05-StartingTripoli.md "Starting Tripoli") section.

## PC:

Double-clicking the Tripoli .jar file should work on a PC right away, as long as you've installed Java. However, if you have an old Java installation, Windows might try and fail to open Tripoli with your older version. To fix this problem, we've created a .bat file, which you can download here:
Expand Down
13 changes: 13 additions & 0 deletions setup/99-MacSecuritySettings.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,13 @@
## Mac:

The security settings on your Mac are likely configured so that you get a warning when you try and open an app that you downloaded from the internet. Tripoli is not malware, and we are not secretly downloading your unpublished data -- we have enough of our own! To open Tripoli anyway, open System Settings (the gear icon on your dock), then click on "Privacy and Security" in the left-hand menu. Scroll down on the right-hand side of the window until you see a prompt asking if you want to "Open Anyway".

```{image} ../graphics/MacPrivacyAndSecuritySettings.png
:alt: Mac Privacy and Security Settings
:width: 400px
:align: center
```

Click the "Open Anyway" button, enter your password if needed, and the Tripoli application will open.

You only need to go to Privacy and Security settings once to open this .jar file. Double-clicking on it in the future will just open Tripoli. However, when you download a new version of Tripoli with a new version number and filename, you'll need to repeat the process. Or, you can open Tripoli from the command line using the instructions in the [Starting Tripoli](../using_Tripoli/05-StartingTripoli.md "Starting Tripoli") section.
65 changes: 62 additions & 3 deletions using_Tripoli/05-StartingTripoli.md
Original file line number Diff line number Diff line change
Expand Up @@ -32,10 +32,69 @@ Before you start Tripoli, make sure that you have:

In most cases, the simplest way to start the Tripoli application is to double-click on the .jar file you downloaded from [the GitHub repository](https://github.com/CIRDLES/Tripoli "GitHub Repository"). The .jar file contains everything you need to open the application and start reviewing data. This approach is likely the best when setting up Tripoli on a shared lab computer, where users with a variety of software comfort levels will be opening Tripoli. If you just double-clicked the Tripoli .jar file and nothing happened, or you got a warning, see OS-specific troubleshooting below.

```{include} ../setup/99-MacSecuritySettings.md
```

## PC:

If you're using an older version of Java for other applications on your PC, then it's possible that this older version is associated with your .jar file extension.

But that's ok!

You can have many Java distributions on your computer at one time. You can still run your other Java applications with the same Java distribution you've been using, and run Tripoli with the newer distribution of Java that includes JavaFX that you downloaded using the [Java Installation Instructions](../setup/01-Installation.md "Java Installation Instructions"). Think of these Java distributions like foreign language translators. The older distribution translates your older Java code into computer-readable instructions and your newer distribution translates the Tripoli software into computer-readable instructions. As long as your computer is using the correct translator the process will be seamless, and both translators (or as many as you wish) can be installed on your computer at the same time.

Unfortunately, when you double-click on a .jar file, your operating system has to make a choice about which Java distribution to use. To point your OS to the newer version of Java when you're opening Tripoli, we've created a batch (.bat) file that contains the correct instructions.

- {download}`Tripoli.bat <../testData/Tripoli.bat>`

Move both the Tripoli .jar file you want to run and the .bat file to a new folder, then double-click on the .bat file to open Tripoli. When you want to update Tripoli, then delete the .jar file for your older version of Tripoli and copy the newer .jar file into the folder with the .bat file.

If this seems like a pain in the neck, then you might be interested in running Tripoli from the command line. It's quick and easy.

# The better way: the command line

A command line interface is a place to type instructions (command lines) that your computer will follow. The advantage here is that you can issue specific commands to your computer and get additional low-level output from the programs you run. While most of us spend most of our time in our operating system's graphical user interface double-clicking on apps to run them, the dinosaurs among the Tripoli user base will recognize an old friend in the familiar DOS prompt from eons ago.

## Mac

Include text from QuickStart.
To use the command line, first you'll need to find it. On a Mac, open Spotlight and type "Terminal" to open the Terminal app. In Linux, you can usually open your Terminal app with `Ctrl`-`Alt`-`T`.

To the left of your cursor, you'll see the name of the folder in your file system that you now have open. To see the name of the complete path to this folder, type `pwd`. Type `ls` to see the contents of the folder. Navigate to your folder containing your Tripoli .jar file using `cd` to change your directory.

## Windows

To use the command line, first you'll need to find it. In Windows, go to the Start menu, type CMD and hit `<Enter>` to bring up the Command Prompt.

To the left of your cursor, you'll see the name of the folder in your file system that you now have open.

```{image} ../graphics/CommandPromptBlank.png
:alt: Windows Command Prompt
:width:
:align: center
```

Now navigate to the folder containing your Tripoli .jar file using `cd` to change directory as needed.

If you don't know how to do this, no problem! Open File Explorer and navigate to the folder containing your Tripoli.jar file.
```{image} ../graphics/WindowsFileExplorer.png
:alt: Windows File Explorer
:width:
:align: center
```

Now put your cursor in address bar at the top of the File Explorer window (just like the address bar on your web browser), type `cmd` and hit `<Enter>`. You now have a Windows command prompt open to your Tripoli folder.
```{image} ../graphics/CommandPromptBlank.png
:alt: Windows Command Prompt open to the Tripoli folder
:width:
:align: center
```

# The better way:
To run Tripoli from the command prompt using Java, type
`java -jar Tripoli-X.X.X.jar` where X.X.X is the version number of Tripoli you're using. For instance, to run Tripoli version 0.5.1, type `java -jar Tripoli-0.5.1.jar`:
```{image} ../graphics/CommandPromptWithJava.png
:alt: Windows Command Prompt with Java command
:width:
:align: center
```
Type `<Enter>` to run Tripoli. You've done it!

Command Line

0 comments on commit e206cea

Please sign in to comment.