Child pages
  • Create or convert a Capsule

Versions Compared

Key

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


Expand
titleWatch video tutorials

Anchor
CreateCapsuleVideo
CreateCapsuleVideo
Create a Capsule

Multimedia
name01 Tutorial Draft - Create a Data Capsule.mov
width75%
height75%

Check Capsule Status

Multimedia
name02 Tutorial Draft - Check Capsule Status.mov
width75%
height75%

Convert a Research Capsule

Multimedia
name03 Tutorial Draft - Convert a Research Capsule.mov
width75%
height75%


Expand
titleRead step-by-step instructions

Navigate to the

...

Capsule Creation Page

Navigate to

...

"Data Capsules" on the top

...

Image Removed

Submit VM Creation Request

On the VM Creation page, fill in the form.

Provide a username and password. The password here is NOT your portal account password.

For other fields, you can fill in by referring to the image below (VM Image=ubuntu-12.04-image, VCPUs=1, Memory(MB)=1024). 

Finally hit the "Create VM button". The VM creation procedure usually takes about 1 minute to complete.

Image Removed

Check VM Status

In the development portal, click on "Experimental Analysis" -> "Virtual Machines" on the top of the page, and you will be navigated to the VM list page. It shows VM ID, status, actions of each VM you have created.

Image Removed

 

...

menu of HTRC Analytics.

Image Added

Create a Capsule

Click Create A Capsule toward the top right.

Image Added


You will be prompted to choose to create either a Demo Capsule or a Research Capsule

 Image Added

Create Demo Capsule

Note:

  • Demo Capsules are not configureable and can access public domain content only.
  • You cannot request to export derived data from a Demo Capsule.

Hit the Create Capsule button. The capsule creation procedure usually takes about 1 minute to complete. Refresh your screen to see if it has finished.

Image Added

You will be prompted to agree to the HTRC Data Capsules Terms of Use. Please review this document as it outlines policy for acceptable in-Capsule behavior. 

Image Added

Create Research Capsule

Note:

  • Demo Capsules are configureable and by default can access public domain content only.
  • You request to export derived data from a Research Capsule.
  • Additional information is required to create your Capsule. 
  • During creation or after it's created, researchers from HathiTrust member institutions can request for their Research Capsule to be converted to one with computational access to the full HathiTrust corpus, including in-copyright content. 

Fill out the form with the title of your research project, and choose the specs for your Capsule. 

There are 2 images you can choose from, one that includes sample public domain volumes from HathiTrust for you to test with, and one that does not. 

Capsule size can range from 2-4 VCPUs and from 4-16 GB of memory. The VCPUs and memory allocation you choose will affect the processing speed of your Capsule. 

Image Added

Add the description for your research project. These answers will be used to aid in reviewing requests to export results from your Capsule. The more information you can provide, the more easily we can assess your results for adherence to the HTRC's Non-consumptive Use Research Policy

Affiliates of HathiTrust member institutions can check the box to request a Capsule with access to the full HathiTrust corpus. 

Image Added

Checking that box will prompt you to fill out additional information about your project. Note: Creation requests from users who check this box will be routed for human review. Your request will be reviewed to verify that you are affiliated with a HathiTrust member institutions and that your request demonstrates serious research intentions in compliance with the HTRC's Non-consumptive Use Research Policy and  HTRC Data Capsules Terms of Use


Image Added

Include more information about your anticipated results to further assist in the human review of your data export requests.


Image Added

If you like, you can choose to allow HTRC to communicate anonymized information about your research project. You must also agree that you will not share your log-in information for HTRC Analytics with anyone. 

Image Added

You will be prompted to agree to the HTRC Data Capsules Terms of Use. Please review this document as it outlines policy for acceptable in-Capsule behavior. You will be reminded of these terms regularly while using your Capsule. 

Image Added

Check Capsule Status 

After creating a capsule, you will be taken back to the Capsules page. By default the capsule you just created is not running. 


 Image Added 

Convert a Research Capsule

HathiTrust member-affiliated individuals can request to convert existing Research Capsules into one with access to the full HathiTrust corpus. 

From your Capsules page, click on the ID of the Capsule you would like to convert. Then, click the button to Request access to Full HathiTrust Corpus.

Image Added

You will be taken to the Capsule creation form. If you submit answers when creating your Capsule, they will appear for you to review and, if desired, edit. You will also be asked to fill in additional information about your research use case. Your request will be reviewed to verify that you are affiliated with a HathiTrust member institutions and that your request demonstrates serious research intentions in compliance with the HTRC's Non-consumptive Use Research Policy and  HTRC Data Capsules Terms of Use

Image Added