Skip to end of metadata
Go to start of metadata

You are viewing an old version of this page. View the current version.

Compare with Current View Page History

« Previous Version 55 Next »


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

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

    Sign Up




    • On the Sign Up page, enter requested information together with username you intend to use and password. The password must meet these requirements:                                    
      • Password must be more than 15 characters long.
      • Password must contain characters from three of the following five categories:
        • Uppercase characters of European languages (A through Z, with diacritic marks, Greek and Cyrillic characters)
        • Lowercase characters of European languages (a through z, sharp-s, with diacritic marks, Greek and Cyrillic characters)
        • Base 10 digits (0 through 9)
        • Nonalphanumeric characters
        • Any Unicode character that is categorized as an alphabetic character but is not uppercase or lowercase. This includes Unicode characters from Asian languages.
      • Password must not contain any white spaces.
      • Password must not contain your user ID.

    Trouble shooting: if you can't successfully sign up

    You need to have an academic email to sign up. We maintain a growing list of allowed email domains, e.g. emails ending with .edu or edu.ac or edu.tw. I you find you can't successfully sign up with your academic email then it's probably your email domain is not on the list. In this situation, please submit an account request by clicking on the request an account button within the error message on the page.

    Sign In


    • You will receive an email in the email that you registered. Go to your email box, and follow the activation link in the email to activate your account.
    • Now you have created an HTRC Analytics account, you can sign in. On the top right of the page, sign in with your username and password.

     



  2. 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).

    Unable to render {include} The included page could not be found.

  3. Make sure you are still logged in to the HTRC where you just created an account. 

  4. Create a capsule by clicking on Capsule →  Create Capsule on the top menu/ You will be asked to provide information about the capsule you would like to create.

    Unable to render {include} The included page could not be found.

  5. Start the capsule you were assigned by clicking the Start Capsule button on the Show Capsules page.

    On the Capsules page (found under Capsule on the top menu), click on the Start Capsule button.



     

  6. Interact with the capsule via VNC client.

    Unable to render {include} The included page could not be found.

  7. Switch between maintenance and secure mode.

    Each capsule is designed to have 2 modes: maintenance mode and secure mode.
    • In maintenance mode, the user is allowed to access network freely except for HTRC corpus repository and install whatever software they wants. 
    • In secure mode, network access is restricted. The user is only allowed to access a few network addresses e.g., HTRC corpus repository and search service. 

    Any changes user makes to their capsule in secure mode, such as data they download or create during their analysis, will not persist. To save data, you will need to save your data to a special storage area on your capsule called secure volume. The secure volume is invisible in maintenance mode. Follow the further steps in this tutorial to learn how to preserve your capsule between research sessions.

    To switch modes, on the Capsules page, click on the Switch to Secure Mode or Switch to Maintenance Mode buttons to switch to the other mode, as shown below. You can practice switching modes, but you'll need your capsule in maintenance mode to follow the rest of the tutorial.



     

  8. Run experiments. Follow the Use Case guides for examples.

    Unable to render {include} The included page could not be found.

  9. Save your interim data between research sessions.

  10. Stop the capsule. The next time you log in, you can restart the same capsule and continue your work.

    (This is the same as Release results)

    If you'd like to export results out of the capsule, you must release them from your virtual machine.

    First, switch the VM to secure mode in the Portal interface. 

    Second, open a terminal in the capsule, navigate to the secure volume by typing:

    cd /media/secure_volume

    Suppose the file you'd like to release is at /home/demouser/demo/r/Rplots.pdf

    You can prepare the result data for release by first adding it the the release list: 

    releaseresults add /home/demouser/demo/r/Rplots.pdf

    Repeat using this command if you have other files to add.

    Finally, to complete the release of your data, type: 

    releaseresults done


    The files will be delivered via email. You will receive them in the email that you registered for the HTRC Analytics account. The email link will be live for 12 hours.

    Shut Down the VM

    Go back to  HTRC Analytics, go to "Data Capsules" and click on the "Stop Capsule" button to shut down the VM you'd like to shut.

    Delete the VM

    If you do not need the capsule any more, you can delete it. On HTRC Analytics, navigate to "Data Capsules", click on the "Delete Capsule" button next to the virtual machine you want to delete.


     

     

  11. Request to export your non-consumptive data.

  12. Delete the capsule.

Questions?

  • No labels