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.
Using an HTRC Data Capsule
For step-by-step instructions, follow a tutorial or user guide.
Administering a Capsule
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 below)
See status - view your capsules and their statuses
Interact - use your capsule either through a desktop view or a terminal (command line) view
Maintenance vs. Secure Mode
The capsules are configured with special security settings that allow you to interact with them in two modes: maintenance mode and secure mode
- In maintenance mode, you are allowed to access the network freely and install whatever software you want.
- In secure mode, general network access is restricted, but you can access the HTRC corpus repository, which is otherwise blocked. Any changes you make to the capsule in secure mode will not persist. To save data from your analysis, you'll need to save your results in the secure volume storage on your capsule. This storage option is not visible in maintenance mode.
Interacting with the Capsule
Access your capsule in-browser from HTRC Analytics either by viewing the Remote Desktop (both modes available) or the Terminal command line interface (Maintenance Mode only). Earlier versions of the capsule environment required a VNC viewer and passwords for both the VNC and the capsule's operating system; those requirements are removed in the web-based version that was implemented in August, 2018. You can also SSH into your capsule in Maintenance Mode only if you've followed the directions under "Advanced Features" to set-up a public key.
To operate your capsule, click on the capsule ID from the capsule list page. Then choose to either view the remote desktop or the terminal. The terminal will work in Maintenance Mode only.
If you've established a key for SSH access, you can also SSH into your capsule when it's in Maintenance Mode by using the command viewable under "Advanced Features" on an individual capsule's status page.
Earlier versions of the capsule environment required passwords for both the VNC and the capsule's operating system; those requirements are removed in the web-based version that was implemented in August, 2018. If you use the included HTRC Workset Toolkit when in your capsule to import data to your capsule, you will be prompted for your HTRC Analytics username and password.
Generic Research Workflow
Create and start a capsule in the HTRC
View your capsule using the Remote Desktop view or Terminal view.
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
HTRC Data Capsule Configurations
Capsule Technical Specifications
You can set several parameters for their capsule during the creation process
- Data Capsule Image: there are two images (versions) of the standard capsule desktop, one that comes pre-loaded with sample volumes from the HathiTrust and one that does not, for the researcher to choose between
- Virtual Machine CPUs (VCPUs): the number of virtual machine processors from 2-4 VCPUs for the capsule, set by the researcher
- Memory: displayed in megabytes, between 4GB and 16GB, set by the researcher
There is an overall disk quota, a memory quota, and a CPU quota for each user in the Data Capsule environment. One user can consume up to 100 GB of disk space, ~20 GB of memory, and 10 CPUs. If you attempt to create a second or third capsule that exceeds your quota in one of the areas above, then you will encounter an error.
Pre-installed Software, Libraries, and Data
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)|
- GenSim (currently running with warning)
- htrc workset toolkit
Sample data and programs
- 3 sample HTRC worksets of 1000 volumes each: U.S. Government Documents, German language volumes, 19th Century English Literature.
- Topic Explorer: http://inphodata.cogs.indiana.edu/
Non-consumptive Exports from an HTRC Data Capsule
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:
- Files containing any OCR text or images of pages or volumes will be prohibited from leaving a capsule.
- Binary files are prohibited from leaving a capsule
- Encrypted files are prohibited from leaving a capsule
- PDF files or other format of file that contains images of OCR text or text images are prohibited from leaving a capsule
- For any capsule results directory that exceeds 1 MB in total, the collection will not be released pending discussion with the capsule owner