The HTRC Data Capsule is a secure computing environment developed to facilitate non-consumptive text analysis research. Each capsule is a virtual machine (VM) that provides researchers a desktop they can use to perform their investigation of volumes in the HathiTrust Digital Library.
For further information, check out the FAQs.
For step-by-step instructions, follow a tutorial or user guide.
The capsules are configured with special security settings that allow you to interact with them in two modes: maintenance mode and secure mode
Use the HTRC site to handle administrative tasks for your capsule:
Create - a capsule is created, but it is not yet running
Start - turn the capsule on in maintenance mode
Stop - shutdown a capsule
Delete - the capsule is deleted (including its data and settings)
Switch modes - change the capsule from maintenance to secure mode, or vice-versa
See status - view your capsules and their statuses
Interacting with the Capsule Interface
Access and log-in to the interface for your capsule from your desktop using either a VNC client or through SSH. You can log in to a capsule using a VNC client if the capsule is in either maintenance or secure mode. You can only SSH into the capsule when it is in secure mode.
Obtain the requisite information for the capsule under Capsule → Show Capsules → <capsule Id>
ssh -p <your capsule port> email@example.com firstname.lastname@example.org's password: dcuser
Create and start a capsule in the HTRC
Log into the capsule using a VNC client
Configure the software environment of the capsule as needed. Download the scripts or programs you plan to use in your analysis
Switch capsule to secure mode through HTRC
Run your against the secure HTRC corpus repository
Move your results to the secure volume storage on the capsule
Switch capsule back to maintenance mode to regain normal network access
You can set several parameters for their capsule during the creation process
Each capsule comes pre-loaded with the following software, libraries, and data. For more information, consult the ReadMe file on the desktop of your capsule for more details about installed packages.
|Anaconda 3||4.2.0||https://www.continuum.io/anaconda-overview||Supports both Python 2.X and 3.X. See list below for the Python libraries pre-installed (some via Anaconda)|
Data and tools can easily enter a user's capsule, but anything leaving a capsule must undergo review prior to release to the user. The guidelines used during review of the outputs of a capsule are as follows: