Changes for page Working with HDC Project Files in the Command Line Interface
Last modified by Dennis Segebarth on 2024/10/02 18:38
From version 2.1
edited by Susan Evans
on 2023/07/10 22:36
on 2023/07/10 22:36
Change comment:
There is no comment for this version
Summary
-
Page properties (1 modified, 0 added, 0 removed)
Details
- Page properties
-
- Content
-
... ... @@ -1,7 +5,3 @@ 1 -{{box cssClass="floatinginfobox" title="Table of Contents"}} 2 -{{toc depth="2"/}} 3 -{{/box}} 4 - 5 5 The Pilot Command Line Interface (pilotcli) is a binary executable program that provides a convenient way for users to perform file actions and platform-related tasks programmatically. The Pilot Command Line Interface can be downloaded and run on on your local Linux and Linux subsystems (as Windows user, see for instance the [[Windows Subsystem for Linux installation guide>>url:https://learn.microsoft.com/en-us/windows/wsl/install]]) to support large file uploads. For convenience, pilotcli is also pre-deployed and installed in the users JupyterHub accessible via worskpace tools. 6 6 7 7 = Data Stewardship = ... ... @@ -783,111 +783,15 @@ 783 783 784 784 List all datasets that are accessible for the user: 785 785 786 -{{code language="none"}} 787 -$ pilotcli dataset list 788 - Dataset Title Dataset Code 789 ---------------------------------------------------------------------------- 790 - dataset2 aug24202102 791 - dataset-01 aug242021 792 -Page: 0, Number of datasets: 2 793 -{{/code}} 794 794 795 -== Command: **show-detail** == 796 796 797 -* **Usage**: Show the detailed information of a dataset. 798 -* ((( 799 -**Prerequisite**: 800 800 801 -* User login is required, otherwise an error is returned: "The current login session is invalid. Please login to continue." 802 -))) 803 803 804 -{{code language="none"}} 805 -$ pilotcli dataset show-detail --help 806 -Usage: pilotcli dataset show-detail [OPTIONS] CODE 786 +---- 807 807 808 - Show details of a dataset. 788 +- 789 +{{code language="none"}}{{/code}} 809 809 810 -Options: 811 - --page INTEGER The page to be listed [default: 0] 812 - --page-size INTEGER number of objects per page [default: 10] 813 - -d, --detached whether run in detached mode 814 - --help Show this message and exit. 815 -{{/code}} 816 - 817 -=== Examples === 818 - 819 -Show the details of the specified Dataset by providing the unique Dataset Code - “aug242021” in this case: 820 - 821 -{{code language="none"}} 822 -$ pilotcli dataset show-detail aug242021 823 --------------------------------------------------------------------------------- 824 -| Title | dataset-01 | 825 --------------------------------------------------------------------------------- 826 -| Code | aug242021 | 827 --------------------------------------------------------------------------------- 828 -| Authors | uname, cli | 829 --------------------------------------------------------------------------------- 830 -| Type | GENERAL | 831 --------------------------------------------------------------------------------- 832 -| Modality | neuroimaging, microscopy, histological approach | 833 --------------------------------------------------------------------------------- 834 -| Collection_method | import, test, upload | 835 --------------------------------------------------------------------------------- 836 -| Tags | tag1, tag2, tag3 | 837 --------------------------------------------------------------------------------- 838 -| Versions | 1.0, 1.1, 1.2 | 839 --------------------------------------------------------------------------------- 840 -{{/code}} 841 - 842 -== Command: **download** == 843 - 844 -* **Usage**: Download a particular version of a dataset. 845 -* **Options**: -v ~-~-version 846 -* ((( 847 -**Prerequisite**: 848 - 849 -* User login is required, otherwise error is returned: "The current login session is invalid. Please login to continue." 850 -))) 851 - 852 -{{code language="none"}} 853 -$ pilotcli dataset download --help 854 -Usage: pilotcli dataset download [OPTIONS] [CODE]... OUTPUT_PATH 855 - 856 - Download a dataset or a particular version of a dataset. 857 - 858 -Options: 859 - -v, --version TEXT Download a particular version of a dataset. 860 - --help Show this message and exit. 861 -{{/code}} 862 - 863 - 864 -=== Examples === 865 - 866 -Download a Dataset with Code “aug242021”: 867 - 868 -{{code language="none"}} 869 -$ pilotcli dataset download aug242021 ~/Downloads/ 870 -Pre downloading dataset 871 -Preparing status: READY_FOR_DOWNLOADING 872 -start downloading... 873 -Downloading aug242021_1632342868.882398.zip |██████████████████████████████ 100% 00:00 874 -File has been downloaded successfully and saved to: /home/uname/Downloads/aug242021_163234 875 -2868.882398.zip 876 -{{/code}} 877 - 878 -Download the version 1.1 of a Dataset with Code “aug242021”: 879 - 880 -{{code language="none"}} 881 -$ pilotcli dataset download aug242021 ~/Downloads/ -v 1.1 882 -Current dataset version: 1.1 883 -Pre downloading dataset 884 -start downloading... 885 -Downloading aug242021_2021-08-24 11:10:00.042277.zip |██████████████████████████████ 100% 00:00 886 -File has been downloaded successfully and saved to: /home/uname/Downloads/aug242021_2021-08-24 11:10:00.042277.zip 887 -{{/code}} 888 - 889 - 890 - 891 891 ---- 892 892 893 893 Copyright © 2023 [[Indoc Research>>url:https://www.indocresearch.org/]].