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

Register

an account on HTRC Portal, from where you will access the HTRC Data Capsule. Read the guide if you need assistance

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.

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

Install a VNC Client on your computer to enable the communication between your computer and the capsule, which is a virtual machine, to be created. You can choose any VNC client you prefer. We use VNC View for Google Chrome in this tutorial, but recommend users explore RealVNC, Chicken, or Screen Share (on a Mac).

Expand
titleInstall software to your computer
Include PageSoftware InstallationSoftware InstallationMake sure you are still logged in to the HTRC where you just created an account. 
Create a


From the Analytics homepage, create a capsule by clicking on Capsule

→  Create Capsule on

 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

Capsule
Create or convert a

capsule

Capsule


Start the capsule you

were assigned

created by clicking the Start Capsule button on the

Show

Capsules page.

Expand
titleStart the capsule

Include Page
Start the VM
Start the VM


Interact with the capsule

via VNC client

either via Remote Desktop viewer or Terminal viewer.

Expand
titleUse your capsule

Include Page
Interact with the

VM via VNC ClientInteract with the VM via VNC Client

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

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.


Image Added

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.

Image Added

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



Switch between maintenance and secure mode.

Expand
titleSwitch capsule modes

Include Page

COM:Mode Switch: Maintenance and Secure ModesCOM:Mode Switch: Maintenance and Secure Modes

Run experiments. Follow the Use Case guides for examples.

Expand
titleConduct research in the capsule
Include PageINT:Run Experiments, Release ResultsINT:Run Experiments, Release ResultsSave your interim data between research sessions.
Stop the capsule

Switch capsule modes
Switch capsule modes


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

Expand
titleShare capsule

From your capsule listing page, click on the Data Capsule ID for the capsule you would like to share.

Image Added


Then, click the button that says Manage Collaborators.

Image Added


You will be taken to a new page, where you can input the email address for the user you would like to add.

Image Added


The email address must be the one associated with their HTRC Analytics account or you will get an error.

Image Added


When you successfully add a collaborator, that user's information will appear in the table of collaborators. By default, they will have the role of Contributor. Contributors can access the capsule and interact with it in its current state. You will have the role of Owner-Controller.

Image Added


Before the new Contributor can access the capsule, they will need to agree to the Data Capsules Terms of Use. You will also be unable to delegate control of the capsule to them until they have agreed.

Once they have agreed to the Terms of Use, you can choose to make them a Controller of the capsule by clicking the "delegate control" button.


Image Added


Once complete, you'll find that their role has changed to Controller. Only the Controller can start, stop, and switch the modes of the capsule. (The Owner-Controller likewise can do these tasks.)

Image Added


Your role has changed to Owner. The owner can delete the capsule and revoke control from the Controller. Click on the "revoke control" button to resume Owner-Controller status.


Image Added


Now the collaborator again has the role of Contributor and you are Owner-Controller.

Image Added


If you no longer want to share your capsule with a user, click the red 'X' button.


Image Added


When they are removed, you'll see the collaborators table has returned to displaying only you as associated with this capsule.

Image Added



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. You can follow the Use Case guides for examples of how to perform text analysis in the capsule. 

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

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:

Code Block
cd /media/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.

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

Expand
title
Turn off the capsule
Export non-consumptive results

Include Page
Finishing Up
Finishing Up

Request to export your non-consumptive data.
  • Delete the capsule.
  • Questions?

    Please refer to the Data Capsule FAQ Frequently Asked Questions (FAQ)

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


    Questions?