Once you have your capsule running, you may find it useful to open this guide in an internet browser in your capsule so you can copy and paste commands. The short link for this page is: https://wiki.htrc.illinois.edu/x/TQFRAQ

  1. Register for an HTRC account if you do not already have one. Read the guide for extended directions, or follow the steps in the link below.

  2. From the Analytics homepage, create a capsule by clicking on Capsule  on the top menu. You will be asked to provide information about the capsule you would like to create. This step also explains how to create or convert an existing Capsule to one with access to the full HathiTrust corpus, for HathiTrust members only. 

  3. Start the capsule you created by clicking the Start Capsule button on the Capsules page.

  4. Interact with the capsule either via Remote Desktop viewer or Terminal viewer. 

  5. Alternatively, you can SSH into your capsule when it is in maintenance mode only. 

    First, you will need a public key. Click "Advanced Features" in the blue box to establish your public key at the bottom of your Capsules page.

    You will be prompted for a key. If you do not yet have a public key set up, then entering one will establish your key. If you already have a key, resubmitting a response in this box with change your key.

    You'll find the command to SSH into your capsule in the blue "Advanced Features" box on each capsule's status page.

  6. Switch between maintenance and secure mode.

  7. Bring text data into your capsule.

  8. Perform your analysis. You can follow the Use Case guides for examples of how to perform text analysis in the capsule. 

  9. If you will need more than one session to complete your research, save your interim data.

    Save data to the Secure Volume

    Make sure your capsule is in secure mode (see directions above if needed).

    Open a terminal window in the capsule and navigate to the secure volume by typing:

    cd /media/secure_volume

    Suppose the file you'd like to release is at /home/demouser/demo/r/Rplots.pdf

    You can prepare the result data for release by adding it, which is done by typing the command:   

    releaseresults add /home/demouser/demo/r/Rplots.pdf

    Repeat using this command if you have other files to add.

  10. Between sessions, stop the capsule via the HTRC using the web browser on your personal desktop. The next time you log in, you can restart the same capsule and continue your work.

  11. When you are finished with your research, request to export your non-consumptive results. 

  12. When you no longer need it, delete your capsule via the HTRC.