QuickStart

 =PALMS Quick Start for New Users=
 * =The Basic Steps=

[|Terminology]
||

 This step-by-step guide is intended to get you up and running with PALMS quickly by walking you through a specific example. As you read through each of the seven steps, you can watch video demonstrations of each step by clicking on the movie icon next to each section header. After you have finished with this Quickstart tutorial, you may want to read the PALMS User Manual for a more detailed discussion of the PALMS feature set and capabilities. (Coming soon) In this guide, steps in green are data which should be entered into the PALMS system. To successfully use this Quickstart guide, download the following files to your own computer: These files will be uploaded into the PALMS system as part of this quickstart example. You may also want to review the [|Terminology] page to familiarize yourself with the PALMS nomenclature.
 * ~ =Introduction= ||~  ||
 * [|QS_Actigraph.csv]
 * [|QS_QSTARZ_raw.csv]


 * [|[TOP]]**

 @https://palms.ucsd.edu:8443/PALMS and enter the username and password provided to you by the PALMS administrator (Figure 1). To obtain a login combination, contact the PALMS Administrator.
 * ~ =Step 1: Logging In= ||~ [[image:https://palms.ucsd.edu:8443/QuickStart/images/MovieIcon.png link="@https://palms.ucsd.edu:8443/QuickStart/videos/LoggingIn.avi"]] ||
 * Note: If an incorrect password is entered three times in a row, you will not be able to reenter the system for 4 hours.**




 * [|[TOP]]**

 [|logged into the system] you will see the list of studies currently in the system. To add a new study, click on the "Add Study" button at the bottom or on the + sign in the upper right of the grid, as shown in Figure 2.
 * ~ =Step 2: Creating a New Study= ||~ [[image:https://palms.ucsd.edu:8443/QuickStart/images/MovieIcon.png link="@https://palms.ucsd.edu:8443/QuickStart/videos/CreatingNewStudy.avi"]] ||



After clicking the "Add Study" button, the Add Study screen will allow you to enter the name of your new study. Also, select from the dropdown menu the study group name to which you have been assigned. Then click on the "Save" Button as shown in Figure 3.

You have successfully created a new study and can now enter the study's parameters.


 * [|[TOP]]**

 [|creating a new study], click on the "Study" menu at the top of the page as shown in Figure 4.
 * ~ =Step 3: Enter Study Parameters= ||~ [[image:https://palms.ucsd.edu:8443/QuickStart/images/MovieIcon.png link="@https://palms.ucsd.edu:8443/QuickStart/videos/EnterStudyParameters.avi"]] ||



You will then see the study information screen shown in.



Information will need to be entered into the three sections of this screen: Study Information section, Study Devices section, and Study Calculations section. Click on the "Edit" (Figure 5) button to bring up the "Edit Study Information" screen (Figure 6).



From the study information screen, enter the following information then click on the “Save” button: After entering information into the Study Information fields, click on the “Add” button inside of the “Add Device to Study” section shown in [|Figure 7]. This will show the complete list of data acquisition devices that are currently compatible with PALMS.
 * Study Name**- A unique name to be assigned to the study. - For this quickstart example, enter "MyNewStudy1" **PI’s Name**- The name of the Prinicipal Investigator of the study. - For this quickstart example, enter your first and last names. **Start Date**- The start date of the study - For this quickstart example, enter today's date **End Date**- The end date of the study - For this quickstart example, enter today's date **Description**- A description of the study - For this quickstart example, enter "Description of a new study" **Group Name**- The group name to which the CWS belongs. - Please do not alter the value of this field. **Timezone**- The timezone where the organization conducting the study is located. - For this quickstart example, enter the Pacific Standard Time



In the same manner as for the Devices, select a calculation within the “Add Calculation to Study” box as shown in Figure 8.

After information, devices, and calculations have been added to the study. The Study Information screen will appear as in Figure 9.
 * Figure 8: Add calculations to the current working study.** For this quickstart example, select the "GPS, Activity, HR - Process and Merge" calculation. Then click on the "Add" button.

After information has been added to the “Study Information,” “Devices,” and “Calculations” sections, you may now proceed to add Participants to the study.
 * Figure 9: Completed Study Information screen**


 * [|[TOP]]**

   
 * ~ =Step 4: Enter Participants= ||~ [[image:https://palms.ucsd.edu:8443/QuickStart/images/MovieIcon.png link="https://palms.ucsd.edu:8443/QuickStart/videos/EnterParticipants.avi"]] ||

    **[|[TOP]]**

 
 * ~ =Step 5: Upload Datasets= ||~ [[image:https://palms.ucsd.edu:8443/QuickStart/images/MovieIcon.png link="https://palms.ucsd.edu:8443/QuickStart/videos/UploadDatasets.avi"]] ||

   [|QA_Actigraph.csv] file then click on the "Upload" button. Wait for the upload to complete. Now that the Actigraph file has been uploaded, we need to upload the QStarz file in the same manner as for the Actigraph file by first selecting the GPS = Qstarz device from the Import Datasets section (Figure 15). Then uploading the QS_QSTARZ_raw.csv file from the upload menu. (Figure 16)
 * Figure 14: Upload Actigraph file.** Add files by clicking on the "Add" button. Then click on the "Upload" button to upload the files to the PALMS server. For this quickstart example, upload [|QS_ActiGraph.csv]

When both the QS_Actigraph.csv and QS_QSTARZ.csv files have been uploaded, you are ready to run calculations.
 * Figure 15: Selection of QStarz format.**
 * Figure 16: Upload QStarz file.** For this quickstart example, upload [|QS_QSTARZ_raw.csv] Then click on the upload button.


 * [|[TOP]]**

 [|study has been created], [|the participants have been entered], [|and the datasets have been uploaded], you are ready to setup and run calculations. Select a calculation to run by clicking on the "Calculations" menu at the top of the screen as shown in Figure 17. Select the calculation you would like to run. To run a calculation, select the "Default" protocol as shown in Figure 18, accept all of the default parameters, enter the result name "result1", and click on the "Start Calculation" button to begin the calculation (Figure 19). The calculation may take several minutes to complete.
 * ~ =Step 6: Setup the Protocol and Run a Calculation= ||~ [[image:https://palms.ucsd.edu:8443/QuickStart/images/MovieIcon.png link="https://palms.ucsd.edu:8443/QuickStart/videos/SetupProtocol.avi"]] ||
 * Figure 17: Calculations menu with two calculations.**Select the calculation you would like to run from this menu. For this quickstart, select the "GPS, Activity, HR - process and Merge (R2 beta)" calculation.

After the calculation completes, you will be taken to the results page.
 * Figure 18: Select the Protocol.** For this quickstart example, select "Default".
 * Figure 19: Click on the Start Calculation button to begin the calculation.** For this quickstart example, set the Result Name to result1.
 * [|[TOP]]**

 
 * ~ =Step 7: View Results= ||~ [[image:https://palms.ucsd.edu:8443/QuickStart/images/MovieIcon.png link="https://palms.ucsd.edu:8443/QuickStart/videos/ViewResults.avi"]] ||

  **[|[TOP]]**
 * ~ Icon ||~ Definition ||
 * [[image:https://palms.ucsd.edu:8443/QuickStart/images/VisualizationIcon.PNG]] || Visualization of merged dataset, includes options to view data table, mapped coordinates, and timeline ||
 * [[image:https://palms.ucsd.edu:8443/QuickStart/images/DataTableIcon.PNG]] || View merged data table ||
 * [[image:https://palms.ucsd.edu:8443/QuickStart/images/CSVIcon.PNG]] || Export merged dataset as a comma separated value (CSV) file ||
 * [[image:https://palms.ucsd.edu:8443/QuickStart/images/KMLIcon.PNG]] || Export merged dataset as a KML file. Load this file into the [|Google Earth application] ||
 * [[image:https://palms.ucsd.edu:8443/QuickStart/images/ProtocolIcon.PNG]] || View protocol used to create results dataset. ||
 * [[image:https://palms.ucsd.edu:8443/QuickStart/images/LogFileIcon.PNG]] || View calculation log file. ||
 * [[image:https://palms.ucsd.edu:8443/QuickStart/images/DeleteIcon.PNG]] || Delete result. ||

You have successfully created a study, defined a study, added participants to the study, uploaded data files, set up protocol parameters, run a calculation, and viewed results. We hope PALMS becomes a useful research tool for you, your group, and your colleagues. Please feel free to send questions or comments about this Quickstart guide to the maintainer of this page.

Last updated: May 4, 2011