| Excerpt |
|---|
View this page for acomprehensive list of all data capsule-specific tutorials. |
| 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
- Register and sign in to your HTRC account.
- Create and start a Capsule in the HTRC.
- View your Capsule using the Remote Desktop view/Terminal view, or SSH into your capsule in maintenance mode.
- 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 analysis 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.
Step-by-Step Instructions
Note: You will need to create an HTRC account if you don't already have one.
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 |
|---|
|
| 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.
Interact with the capsule either via Remote Desktop viewer or Terminal viewer.
| Expand |
|---|
|
| 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 |
|---|
| title | SSH access in maintenance mode |
|---|
|
| Include Page |
|---|
| SSH access in Maintenance Mode |
|---|
| SSH access in Maintenance Mode |
|---|
|
|
Switch between maintenance and secure mode.
| Expand |
|---|
| title | Switch capsule modes |
|---|
|
| Include Page |
|---|
| Switch capsule modes |
|---|
| Switch capsule modes |
|---|
|
|
Share your Research Data Capsule with up to 5 other researchers.
| Expand |
|---|
|
| Include Page |
|---|
| Managing Data Capsule Collaborators |
|---|
| Managing Data Capsule Collaborators |
|---|
|
|
Bring text data into your capsule.
| Expand |
|---|
|
| 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 |
|---|
| title | See example use cases |
|---|
|
|
If you will need more than one session to complete your research, save your interim data to the Secure Volume.
| Expand |
|---|
| title | Save 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 |
|---|
|
| 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 |
|---|
| title | Export non-consumptive results |
|---|
|
|
What to do if you need help troubleshooting problems with your data capsule:
| Expand |
|---|
| title | Request help directly from your data capsule |
|---|
|
| Include Page |
|---|
| Request Data Capsule Help |
|---|
| Request Data Capsule Help |
|---|
|
|