6.2_Installation.txt

/**

\page Installation Installation Instructions

\subsection Windows

- Download the ".msi" installer file and double click to open.
- On Windows 10, sometimes, Microsoft Edge does not let you download installers from unknown sources for security purposes (the warning comes up after the download finishes); you will need to select "Keep File" and follow prompts.
- If a security prompt comes up after opening the installer, click on "Run Anyway".
- Follow prompts for installation.

\subsection Linux

- Linux users have a CaPTk AppImage available called `CaPTk_${Version}.bin`. 
- To run the AppImage, first open a terminal in the same directory as the .bin file.
- You will want to make sure it is runnable as an executable with the following command:
\verbatim
chmod +x CaPTk_${Version}.bin
\endverbatim
- To install CaPTk to the current directory where the AppImage was downloaded, run the following command:
\verbatim
./CaPTk_${Version}.bin
\endverbatim
- To specify a preferred directory to install CaPTk, run the following command:
\verbatim
./CaPTk_${Version}.bin --target {path_to_preferred_directory}
\endverbatim
- Follow prompts to install.

\subsection macOS

<b>For CaPTk Versions prior to 1.9.0:</b>
- Users will download the ".pkg" file from NITRC; double-click the file. 
- If there is a window saying that this is an "unidentified developer", hit "OK" and then go to "System Preferences > Security and Privacy" and you need to click on "Open Anyway" beside the "CaPTk_$version.pkg" (this will prompt for your password).
- Double click on the pkg file and click on "Open". This will guide you through the installation screen with licensing information.
- Before installation begins, you may be prompted for your password again.
- You will find CaPTk under your "Applications" folder and you can delete the disk image.

<b>For CaPTk versions 1.9.0 and greater:</b>
- macOS users will need to download Docker (https://docs.docker.com/get-docker/)
- Then pull the container from Docker Hub (https://hub.docker.com/r/cbica/captk), example command: 
\verbatim
docker pull cbica/captk
\endverbatim
- The container can be run with:
\verbatim
 docker run -it cbica/captk [args go here]
 \endverbatim
- The above is sufficient for command line use. To enable the graphical user interface, you will need to set up graphical sharing. We cannot provide technical support for Docker, but this article contains an example: https://cntnr.io/running-guis-with-docker-on-mac-os-x-a14df6a76efc
- In order to process your files with CaPTk, you will need to mount your input directory into Docker. Please see the Docker documentation for examples on how to do this. The "docker run" command can do this at startup, example: https://docs.docker.com/engine/reference/commandline/run/#mount-volume--v---read-only

--------------------------------------------------------------------

--------------------------------------------------------------------

\htmlonly
<div align="right"><a href="ReleaseNotes.html"><b>Next (Changelog)<b></a>
\endhtmlonly

--------------------------------------------------------------------
*/