Difference between revisions of "Getting Started"

From iDigBio
Jump to: navigation, search
(Get the Package and Run on Linux)
(Get the Package and Run on Windows)
Line 11: Line 11:
  
 
== Get the Package and Run on Windows ==
 
== Get the Package and Run on Windows ==
* Download the zip file for Windows from [http://www.acis.ufl.edu/~yonggang/idigbio/1.0.1/idigbio_image_ingestion_tool.1.0.1.win32.zip here (Windows Vista and up)].
+
* Download the zip file for Windows from [https://github.com/iDigBio/idigbio-ingestion-tool/releases/ here - select the latest version for your operating system (Windows Vista an up)]
* Unzip the downloaded file "idigbio_image_ingestion_tool.1.0.1.win32.zip" using the tool you have.
+
* Unzip the downloaded file
* Go into the directory "idigbio_image_ingestion_tool.1.0.1.win32", and double click the file "iDigbio Image Ingestion Tool.exe".
+
* Go into the directory you extracted, and double click the file "iDigbio Image Ingestion Tool.exe".
 
<center>[[File:win_install_1.png | 500px]]</center><br>
 
<center>[[File:win_install_1.png | 500px]]</center><br>
 
* The idigbio application user interface will be brought up automatically in your default web browser. If not, please input the URL [http://127.0.0.1:32601 127.0.0.1:32601] in your web browser.
 
* The idigbio application user interface will be brought up automatically in your default web browser. If not, please input the URL [http://127.0.0.1:32601 127.0.0.1:32601] in your web browser.

Revision as of 17:22, 8 June 2015


Get the Package and Run on Linux

  • Download the zip file for Linux from our binary release page.
  • Unzip the downloaded file
  • Go into the directory "idigbio-ingestion-tool-master" and double click the file "main.py".
  • Select "Run in Terminal".
Linux install 1.png

  • The idigbio application user interface will be brought up automatically in your default web browser. If not, please input the URL 127.0.0.1:32601 in your web browser.

Win install 2.png

Get the Package and Run on Windows

Win install 1.png

  • The idigbio application user interface will be brought up automatically in your default web browser. If not, please input the URL 127.0.0.1:32601 in your web browser.


Win install 2.png

Signing In with Your Account Information

  • If this is the first time you are using this application, you need to log in with your iDigBio Account UUID and the API Key. You may request the login combination from iDigBio. You can get a account UUID / API key pair by [following this].
  • Fill in your login information in the dialog box after you launch the application, as shown below.
Sign in.png
  • Once you have successfully signed in, your Account UUID and API Key are saved on your computer and you don't need to sign in again next time you open the appliance.

Image Ingestion Tool at a Glance

Main page2.png
  • Upload via CSV : Upload media files using a CSV file.
  • Upload History : View the history of previous uploads from user's computer.
  • Generate CSV : Create a CSV file for the images in a folder.

Image Ingestion Procedures

  1. At first, you want to make a CSV (Comma Separated Value) file. The CSV should contain the information describing the media files that you are about to upload. We recommend you use the "Generate CSV" tab if you are not familiar with a CSV file.
  2. After the CSV file is ready either by manually creating one or by the generation step, you can upload media files through "Upload via CSV" tab.
  3. You can always check the previous uploads through the "Upload History" tab.
  • Hereafter, we present an example of uploading a collection of image files from the folder, presented in a step by step manner. It consists of two steps. The first is generating a CSV file and then the second is uploading image files with the CSV descriptive file.

Generate a CSV File

  • Begin by clicking the "Generate CSV" tab.
Generate csv 2.png
  • When you type in the path of the folder, it would be easier to copy the path from the browser address bar.

Generate csv 1.png
  • Then specify the GUID syntax. If you are not familiar about the differences among the selections in the drop down menu, you can simply use "hash of the record information". Finally, type in the destination path to the CSV file.
  • A complete list of all fields in the CSV file can be found here: Input CSV Format.

Upload Images using a CSV File

  • Now you upload a folder of images through a CSV file. At first, specify the image license from the drop-down menu, then type in the path to CSV file that you created. Finally, click the upload button.
Upload via csv 1.png
  • On successful upload, you should see the result similar to the one shown below.

Success result 1.png

Resuming a Failed Upload Batch

  • If not all the images in the batch are successfully uploaded, you can see which media failed to upload.

Falure result 2.png

  • To continue with the batch, just click the yellow "Retry failed upload" button. Note that the previously uploaded images are "skipped" (as shown above the progress bar).

Show the History of Previous Uploads

  • When you click on the "Upload History" tab, you will see all the previous upload batches shown like this. Use the "Save CSV for all history" button to save all the history to the specified directory.
History 2.png
  • See the details of each uploaded batch by clicking on each of entries.

History 3.png

Go Back to Appliance Main Page