Working with Unstructured Data in a BC-workspace

In order to download unstructured data, or data that has been uploaded in the original file format provided by the submitter, you must use the bc-client. 

The bc-client is preinstalled in your BC-workspace. 

To use it, just type "bc-client" on the command line of a terminal window (Linux) or PowerShell (Windows). This will display all the bc-client commands.

Creating a Profile

To create a profile, you will need to provide a Name, the link to your credentials file, which you must have previously uploaded to your BC-workspace as described in the relevant Help article and the API endpoint https://internal.api.braincommons.org

> bc-client configure --profile=MyProfileName --cred=/data/upload/credentials.json --apiendpoint=https://internal.api.braincommons.org

Test that your Profile works

To test that your Profile works, you can check your entitlements for the selected credentials file. 

> bc-client auth --profile=MyProfileName

This command will list all projects that you the credentials file that you used in your profile has access to.

Download unstructured files to your BC-workspace for analysis

To download files to your BC-workspace, you will need a file manifest. You can create one from the Data Explorer page and copy it to your workspace. Once you have a file manifest, you can download multiple files with the following command

> bc-client download-multiple --profile=MyProfileName --manifest=<path-to-manifest/manifest.json> --download-path=<path-to-file-dir>