Versions Compared


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


At this point, the script will be downloaded to your computer’s hard disk, and you will see the message at the bottom left of your browser window be replaced by just the name of the downloaded file:

 3.8 Additional steps for Windows users only


Windows users will need to install a Unix shell in order to run the rsync script. The most common one is Cygwin. Please refer to its documentation on how to install it, taking care to include the rsync package in the installation.

If you are new to Cygwin, you may not be familiar with how to navigate to your C: drive to find the HTRC-generated rsync file you just downloaded. The following FAQ page provides information about how to locate your C: drive from the Cygwin shell.

3. 9 Run the script returned by the EF_Rsync_Script_Generator algorithm


Find the downloaded file on your hard disk. It is a shell script you can run from a terminal window. When you run it, a  

3. 8 Run the script returned by the EF_Rsync_Script_Generator algorithm

Windows users please note: Before proceeding, Windows users will need to complete additional steps to prepare their machine to work with rsync. Please follow the directions here.


After you download the script, from the command line navigate to the directory where the script file is located. This directory will typically be called Downloads, though the location may be different depending on your machine and if you have moved the file. Here is an example:

Code Block
cd ~/Downloads


Once you are in the directory where the file is located, you may be interested in checking the file size to verify that the script exists:

Code Block
ls -l

Then run the file you downloaded. It is a shell script. When you run it, a basic features data file and an advanced features data file for each volume in your workset will be transferred to your hard disk via the rsync utility.



You can check the file size using the  ls -l command at the Unix shell prompt, and then execute the EF_Rsync script, as shown below. 


-rw-r-----@ 1 sayan  GSLIS-AD\sayan  320 May  5 00:53


sent 152 bytes  received 200 bytes  704.00 bytes/sec
total size is 10192  speedup is 28.95
sent 1538 bytes  received 1121 bytes  5318.00 bytes/sec
total size is 171977  speedup is 64.68
Code Block


If your workset contained N volumes with HathiTrust volume IDs V1, V2, V3,... VN respectively, then executing the shell script as shown above will cause the following compressed advanced and basic feature datafiles data files for the corresponding volumes, volumes to be transferred to your computer’s hard disk via rsync:

V1.advanced.json.bz2, V1.basic.json.bz2, 


VN.advanced.json.bz2, VN.basic.json.bz2,to be transferred to your computer’s hard disk via rsync. You will then be able to uncompress these files into text files in json format. You will be able to view the features by opening the uncompressed files in a suitable editor (such as Oxygen), and be able to manipulate the files programmatically. (For this particular workset, recall that there was

For the workset in this example, because it contained only one volume, the book book Buch der Lieder by Heinrich Heine, Heine with the HathiTrust volumeID volumeID mdp.39015012864743. Therefore, the files , the script will transfer two files to your machine. They are the advanced and basic feature data files for the volume in the workset:


mdp.39015012864743.basic.json.bz2 were transferred..bz2 


3. 9 Uncompress the downloaded files

Because the advanced and basic feature data files will be downloaded in a compressed format, next uncompress them into JSON-formatted text files.

You will then be able to view and work with the files in the text editor of your choice.