Installing OpenXY

Installing OpenXY using GitHub Cloning (Recommended)

This approach will require the user to set up a GibHub account and install Git (or GitHub) on their computer. This approach is recommended so that the user will get automatically notified when new changes have been made, and makes receiving these changes extremely easy. For anyone interested in becoming a co-developer on the project, this approach is required.

1. Set up a GitHub Account (GitHub Login)
2. Download and Install GitHub GUI (recommended) (GitHub for Windows, GitHub for Mac) or Git command-line language (Git for Windows, Git for Mac)
3. Sign into GitHub or set up user info in Git (Git Initial Setup Guide)
4. Navigate to OpenXY on GitHub (link to OpenXY)
5. Select "Clone in Desktop" button if using GitHub GUI, or enter git clone https://github.com/BYU-MicrostructureOfMaterials/OpenXY.git into command line.
6. OpenXY includes the quaternion repository as a submodule. To include the quaternion repository open a command terminal and run the following commands in the root directory:

        git submodule init

        git submodule update

        Or run the clone command in step 5 with the recursive option:

        git clone -recursive https://github.com/BYU-MicrostructureOfMaterials/OpenXY.git

To request write-permission:

1. Star OpenXY on GitHub.com
2. Send an email request to [email protected] (include your GitHub ID)

Installing without GitHub

1. Navigate to OpenXY on GitHub (link to OpenXY)
2. Select "Download ZIP" button. Extract folder contents onto computer.
3. Download the quaternion package (found here) and extract into the /OpenXY/Code/quaternions folder.
4. Open MainGUI.m in Matlab and change the Matlab working directory to point to the \Code folder (prompt will appear when the code is run) For system requirements click here.