Skip to content

Commit

Permalink
Updated Docs
Browse files Browse the repository at this point in the history
  • Loading branch information
jbalsamo committed Aug 13, 2019
1 parent e0a75b3 commit b07068a
Showing 1 changed file with 5 additions and 5 deletions.
10 changes: 5 additions & 5 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,9 +2,9 @@

## File Preparation

Start the import process by storing the data in an import folder. The directory should be: _quip folder_/_data_/_xfer_/_input folder_/ on the quip host server. You only need to copy the "heatmap_XXXXXXXXXXXXXXXXXX.json" files for import.
Start the import process by storing the data in an import folder. The directory should be: _quip folder_/_data_/_heatmaps_/_input folder_/ on the quip host server. You only need to copy the "heatmap_XXXXXXXXXXXXXXXXXX.json" files for import. The metadata file is unnecessary because the manifest contains the required data.

Under the input directory "_import folder_", with the heatmap files, you need to also add a manifest file that contains data about the heatmaps you are loading.
Under the input directory "_import folder_", with the heatmap files, you need to also add a manifest file that contains data about the heatmaps you are loading. The heatmap files and be distributed under multiple directories in the "_import folder_" as long as the path is defined in manifest with a relative path (i.e. "./study1/heatmap01.json").

## Usage

Expand All @@ -21,8 +21,8 @@ bash-3.2$ ~/uploadHeatmaps/uploadHeatmaps.sh --help
Usage: $ uploadHeatmaps.sh [options] -c <pathDB_collection>
Options:
-c, --collection <pathDB_collection>: PathDB Collection for heatmaps (*this parameter required)
-i, --input <input_folder>: Folder where heatmaps are loaded from (default: /mnt/data/xfer/input)
-o, --output <output_folder>: Folder where converted heatmaps are imported from (default: /mnt/data/xfer/output)
-i, --input <input_folder>: Folder where heatmaps are loaded from (default: input)
-o, --output <output_folder>: Folder where converted heatmaps are imported from (default: output)
-q, --quip-host <host>: ip or hostname of PathDB Server (default: quip-pathdb)
-h, --data-host <host>: ip or hostname of database (default: ca-mongo)
-m, --manifest <manifest name> (default: manifest.csv)
Expand All @@ -33,5 +33,5 @@ Usage: $ uploadHeatmaps.sh [options] -c <pathDB_collection>
Notes: requires mongoDB client tools installed on running server
```

Depending on the number of images and their resolution it may take some time to complete. Do not stop the process until it completes.
Depending on the number of images and their resolution it may take some time to complete. Do not stop the process until it completes. If an error occurs then no data will be uploaded.

0 comments on commit b07068a

Please sign in to comment.