Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.


Info

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

Overview of Generic Research Workflow in a Capsule

  1. Register and sign in to your HTRC account. 
  2. Create and start a Capsule in the HTRC.
  3. View your Capsule using the Remote Desktop view/Terminal view, or SSH into your capsule in maintenance mode.
  4. Configure the software environment of the Capsule as needed. Download the scripts or programs you plan to use in your analysis.
  5. Switch Capsule to secure mode through HTRC.
  6. Run your analysis against the secure HTRC corpus repository.
  7. Move your results to the secure volume storage on the Capsule.
  8. Switch Capsule back to maintenance mode to regain normal network access.

Step-by-Step Instructions

Register for an HTRC account if you do not already have one. Follow the steps in the "Sign Up and Sign In" link below for directions.

Expand
titleSign up for and sign in to the HTRC
Include Page
Sign Up and Sign In
Sign Up and Sign In


From the Analytics homepage, create a capsule by clicking on Data Capsules 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. 

Expand
titleCreate a capsule

Include Page
Create or convert a Capsule
Create or convert a Capsule


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

Expand
titleStart the capsule

Include Page
Start the VM
Start the VM


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

Expand
titleUse your capsule

Include Page
Interact with the capsule
Interact with the capsule


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

Expand
titleSSH access in maintenance mode

Include Page
SSH access in Maintenance Mode
SSH access in Maintenance Mode


Switch between maintenance and secure mode.

Expand
titleSwitch capsule modes

Include Page
Switch capsule modes
Switch capsule modes


Share your Research Data Capsule with up to 5 other researchers.

Expand
titleShare capsule

Include Page
Managing Data Capsule Collaborators
Managing Data Capsule Collaborators


Bring text data into your capsule.

Expand
titleGet data

Include Page
Fetching Volume OCR Content in HTRC Data Capsule (Secure Mode)
Fetching Volume OCR Content in HTRC Data Capsule (Secure Mode)


Perform your analysis. See the following use cases for examples of how to perform text analysis in the capsule. 

Expand
titleSee example use cases


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

Expand
titleSave data to Secure Volume

Include Page
Save data to the Secure Volume
Save data to the Secure Volume


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.

Expand
titleStop the capsule

Include Page
Stop the Capsule
Stop the Capsule


When you are finished with your research, request to export your non-consumptive results. When you no longer need the capsule, delete it via the HTRC. 

Expand
titleExport non-consumptive results

Include Page
Finishing Up
Finishing Up


What to do if your you need help troubleshooting problems with your data capsule:

Expand
titleRequest help directly from your data capsule

Include Page
Request Data Capsule Help
Request Data Capsule Help


Questions?