diff --git a/brhstaging.data-commons.org/dashboard/Public/img/access_box_select_page_datafiles_080322.png b/brhstaging.data-commons.org/dashboard/Public/img/access_box_select_page_datafiles_080322.png new file mode 100644 index 0000000000..f492ef9bc3 Binary files /dev/null and b/brhstaging.data-commons.org/dashboard/Public/img/access_box_select_page_datafiles_080322.png differ diff --git a/brhstaging.data-commons.org/dashboard/Public/img/discovery_features_080322.png b/brhstaging.data-commons.org/dashboard/Public/img/discovery_features_080322.png new file mode 100644 index 0000000000..d7ce75d4ff Binary files /dev/null and b/brhstaging.data-commons.org/dashboard/Public/img/discovery_features_080322.png differ diff --git a/brhstaging.data-commons.org/dashboard/Public/img/download_discovery_prepared_1_080922.png b/brhstaging.data-commons.org/dashboard/Public/img/download_discovery_prepared_1_080922.png new file mode 100644 index 0000000000..d871d314fa Binary files /dev/null and b/brhstaging.data-commons.org/dashboard/Public/img/download_discovery_prepared_1_080922.png differ diff --git a/brhstaging.data-commons.org/dashboard/Public/img/grid_discovery_color_080322.png b/brhstaging.data-commons.org/dashboard/Public/img/grid_discovery_color_080322.png new file mode 100644 index 0000000000..fc4c23577a Binary files /dev/null and b/brhstaging.data-commons.org/dashboard/Public/img/grid_discovery_color_080322.png differ diff --git a/brhstaging.data-commons.org/dashboard/Public/img/open_data_in_workspace.png b/brhstaging.data-commons.org/dashboard/Public/img/open_data_in_workspace.png new file mode 100644 index 0000000000..8f08e62ad8 Binary files /dev/null and b/brhstaging.data-commons.org/dashboard/Public/img/open_data_in_workspace.png differ diff --git a/brhstaging.data-commons.org/dashboard/Public/img/open_in_workspace_datanb.png b/brhstaging.data-commons.org/dashboard/Public/img/open_in_workspace_datanb.png new file mode 100644 index 0000000000..a6a910396e Binary files /dev/null and b/brhstaging.data-commons.org/dashboard/Public/img/open_in_workspace_datanb.png differ diff --git a/brhstaging.data-commons.org/dashboard/Public/img/open_in_workspace_manifest_path.png b/brhstaging.data-commons.org/dashboard/Public/img/open_in_workspace_manifest_path.png new file mode 100644 index 0000000000..68f8c0136f Binary files /dev/null and b/brhstaging.data-commons.org/dashboard/Public/img/open_in_workspace_manifest_path.png differ diff --git a/brhstaging.data-commons.org/dashboard/Public/img/profile_link_accounts.png b/brhstaging.data-commons.org/dashboard/Public/img/profile_link_accounts.png new file mode 100644 index 0000000000..acc87f0124 Binary files /dev/null and b/brhstaging.data-commons.org/dashboard/Public/img/profile_link_accounts.png differ diff --git a/brhstaging.data-commons.org/dashboard/Public/img/profile_login_other_commons.png b/brhstaging.data-commons.org/dashboard/Public/img/profile_login_other_commons.png new file mode 100644 index 0000000000..07443fd54e Binary files /dev/null and b/brhstaging.data-commons.org/dashboard/Public/img/profile_login_other_commons.png differ diff --git a/brhstaging.data-commons.org/dashboard/Public/img/workspace_data_folder_080322.png b/brhstaging.data-commons.org/dashboard/Public/img/workspace_data_folder_080322.png new file mode 100644 index 0000000000..bf5591a162 Binary files /dev/null and b/brhstaging.data-commons.org/dashboard/Public/img/workspace_data_folder_080322.png differ diff --git a/brhstaging.data-commons.org/dashboard/Public/img/workspace_file_new_notebook.png b/brhstaging.data-commons.org/dashboard/Public/img/workspace_file_new_notebook.png new file mode 100644 index 0000000000..7f498c0431 Binary files /dev/null and b/brhstaging.data-commons.org/dashboard/Public/img/workspace_file_new_notebook.png differ diff --git a/brhstaging.data-commons.org/dashboard/Public/img/workspace_flavors_080322.png b/brhstaging.data-commons.org/dashboard/Public/img/workspace_flavors_080322.png new file mode 100644 index 0000000000..1ef8209c39 Binary files /dev/null and b/brhstaging.data-commons.org/dashboard/Public/img/workspace_flavors_080322.png differ diff --git a/brhstaging.data-commons.org/dashboard/Public/img/workspace_new_080322.png b/brhstaging.data-commons.org/dashboard/Public/img/workspace_new_080322.png new file mode 100644 index 0000000000..977d41e67c Binary files /dev/null and b/brhstaging.data-commons.org/dashboard/Public/img/workspace_new_080322.png differ diff --git a/brhstaging.data-commons.org/dashboard/Public/img/workspace_notebook_download_080422.png b/brhstaging.data-commons.org/dashboard/Public/img/workspace_notebook_download_080422.png new file mode 100644 index 0000000000..8cb4c7259d Binary files /dev/null and b/brhstaging.data-commons.org/dashboard/Public/img/workspace_notebook_download_080422.png differ diff --git a/brhstaging.data-commons.org/dashboard/Public/img/workspace_notebook_save_080322.png b/brhstaging.data-commons.org/dashboard/Public/img/workspace_notebook_save_080322.png new file mode 100644 index 0000000000..879b942a8a Binary files /dev/null and b/brhstaging.data-commons.org/dashboard/Public/img/workspace_notebook_save_080322.png differ diff --git a/brhstaging.data-commons.org/dashboard/Public/img/workspace_pd_folder_080422.png b/brhstaging.data-commons.org/dashboard/Public/img/workspace_pd_folder_080422.png new file mode 100644 index 0000000000..3b66cb99d4 Binary files /dev/null and b/brhstaging.data-commons.org/dashboard/Public/img/workspace_pd_folder_080422.png differ diff --git a/brhstaging.data-commons.org/dashboard/Public/img/workspace_terminal_080422.png b/brhstaging.data-commons.org/dashboard/Public/img/workspace_terminal_080422.png new file mode 100644 index 0000000000..5cda1b396e Binary files /dev/null and b/brhstaging.data-commons.org/dashboard/Public/img/workspace_terminal_080422.png differ diff --git a/brhstaging.data-commons.org/dashboard/Public/img/workspace_upload_080322.png b/brhstaging.data-commons.org/dashboard/Public/img/workspace_upload_080322.png new file mode 100644 index 0000000000..b4e576235e Binary files /dev/null and b/brhstaging.data-commons.org/dashboard/Public/img/workspace_upload_080322.png differ diff --git a/brhstaging.data-commons.org/dashboard/Public/index.html b/brhstaging.data-commons.org/dashboard/Public/index.html index 8e286b402e..730a35c3b9 100644 --- a/brhstaging.data-commons.org/dashboard/Public/index.html +++ b/brhstaging.data-commons.org/dashboard/Public/index.html @@ -91,7 +91,7 @@ Search Features Find available Study-level Metadata Find accessible Datasets - Data Availability Options + @@ -103,18 +103,18 @@ Upload, save, and download Files/Notebooks Environments, Languages, and Tools Python 3 and RStudio in Jupyter - STATA in Jupyter + Automatic Workspace Shutdown - - - - + + + + - a) Download Data Files using the Gen3-client - b) Download Data Files in Workspaces using the Python SDK in + a) Download Data files into a Workspace with the python SDK + b) Download Data Files from the Discovery Page onto a local environment +
  • - Login via InCommons --> NIH eRA: When selecting the NIH/eRA (electronic Research Administration) login using InCommons, you will need access permissions through the eRA Commons account. + Login via InCommons --> NIH eRA: When selecting the NIH/eRA (electronic Research Administration) login using InCommons, you will need access permissions through the eRA Commons account.
  • Access to individual Studies

    @@ -643,7 +642,7 @@

    Access to individual St Access is displayed as a yellow box on top of each Study Page. - -

    Data Availability Options

    + +

  • Not available: This option will filter out all studies that will only have metadata but no datasets available. The checkbox next to the study will be greyed out and non-clickable. @@ -963,7 +960,7 @@

    Data Availability Options Access_greyed_out_box
    Studies will grey out if they're not available, have no data attached, users have no access to, or are in pending mode. -


    --> +

  • Pending: This option will display studies located on any data resource or repository, for which attached datasets will be added in the near future. The checkbox next to the @@ -1013,7 +1010,7 @@

    Data Availability Options demo_df.head()

    More information for instructions on importing data can be found in the sections - "Download Files to Workspaces" and "Workspaces".

    + "Download Files to Workspaces" and "Workspaces".

  • Make sure to terminate the workspace when the work is finished to reduce computational costs. @@ -1046,8 +1043,8 @@

    f) Workspaces

    New to Jupyter? Learn more about the popular tool for data scientists on Jupyter.org (disclaimer: CTDS is not responsible for the content).
    - - + +

    Guideline to get started in Workspaces

    @@ -1055,12 +1052,12 @@

    Guideline to get started in

    1. - Users need to log in via https://brh.data-commons.org/login to access workspaces. + Users need to log in via https://brh.data-commons.org/login to access workspaces.

    2. After navigating to https://brh.data-commons.org/workspace, users will discover a list of pre-configured virtual machine (VM) images, as shown below.

      - Workspace_flavors + Workspace_flavors
      Available workspaces on BRH.
    3. Tutorial Notebooks: Explore our Jupyter Notebook tutorials written in Python or RStudio, which pull data from various sources of the Biomedical Research Hub to leverage statistical programs and data analysis tools. @@ -1102,7 +1099,7 @@

      Guideline to get started in


    4. After launching, the home folders are displayed, one of which is the user's persistent drive ("pd").

      - Workspace_data_folder + Workspace_data_folder
      The /pd directory is a user’s persistent drive.

      @@ -1110,7 +1107,7 @@

      Guideline to get started in

    5. Select the /pd folder. Only files saved in the /pd directory will remain available after termination of a workspace session.

      - Workspace_pd_folder + workspace_pd_folder_080422
      New files or licenses should be saved in the the /pd directory if users need to access them after restarting the workspaces.

      @@ -1125,10 +1122,10 @@

      Guideline to get started in


    6. - Start a new notebook by clicking “New” in the top right corner and choose between Python 3 or R Studio as the base programmatic language.

      - Workspace_new + Start a new notebook by clicking the tiles in the launcher and choose between Python 3 or R Studio as the base programmatic language.

      + workspace_new_080322
      - Start a new notebook under “New”. + Start a new notebook under “Notebook” in the Launcher tab.


    7. @@ -1155,7 +1152,7 @@

      Guideline to get started in

      Further reading: read more about how to download data files into the Workspaces - here. + here.

      @@ -1164,9 +1161,9 @@

      Upload, save, and download Fil

      Users can upload data files or Notebooks from the local machine to the home directory by clicking on “Upload” and access them in the Notebook (see below).

      - Workspace_upload + workspace_upload_080322
      - Upload data files or Notebooks to the workspace by clicking on “Upload” in the top right corner. + Upload data files or Notebooks to the workspace by clicking on “Upload” in the top left corner.

      Then run in the cells, for example:
      @@ -1180,15 +1177,15 @@

      Upload, save, and download Fil

      Users can save the notebook by clicking "File" - "Save as", as shown below.

      - workspace_notebook_save + workspace_notebook_save
      - Save the notebook under “File” - "Save as". + Save the notebook under “File” - "Save Notebook as".

      - Users can download notebooks by clicking "File" - "Download as", as shown below. + Users can download notebooks by clicking "File" - "Download", as shown below.

      - workspace_notebook_download + workspace_notebook_download
      Download the notebook for example as ".ipynb".
      @@ -1223,9 +1220,9 @@

      Environments, Languages,
    8. Python 3 (read more)
    9. -
    10. +

      @@ -1241,17 +1238,17 @@

      Environments, Languages,

      Python 3 and RStudio in Jupyter

      - Both Python 3 and RStudio are available in Jupyter Notebooks.
      Users can expect to be able to use typical Python or RStudio packages, such as PyPI or CRAN. For Python and RStudio, users can start a new notebook under - "New", as shown below. + Both Python 3 and R are available in Jupyter Notebooks.
      Users can expect to be able to use typical Python or R packages, such as PyPI or CRAN. For Python and R, users can start a new notebook with a tile under + "Notebook", as shown below.

      - Workspace_new + Workspace_new
      Find Python 3 or RStudio when starting a new notebook under “New”.
      -

      STATA in Jupyter

      + - leveraging the CTDS-owned python software development kit (SDK) and the tool “Gen3-client” if the file size exceeds 250 MB. + leverages CTDS-owned python software development kit (SDK) as well as a cloud based computing platform. Data used for local work must be downloaded via a manifest and then Gen3-client.

      - +
    11. + Download and configure the Gen3-client
      a. Follow the download instructions of the Gen3-client here. The client can be downloaded + here.

      b. In your terminal, configure your profile using the following command:

      + + gen3-client configure --profile=<profile_name> --cred=<credentials.json> --apiendpoint=<api_endpoint_url>

      + + #Mac/Linux:
      + gen3-client configure --profile=demo
      + --cred=~/Downloads/demo-credentials.json --apiendpoint=https://brh.data-commons.org/

      + + #Windows:
      + gen3-client configure --profile=demo
      + --cred=C:\Users\demo\Downloads\demo-credentials.json --apiendpoint=https://brh.data-commons.org/ +

      + #Output:
      + 10:08:20 Profile 'demo' has been configured successfully.
      +

      If successfully executed, a configuration file will be stored under the directory the user specified under “cred”. For troubleshooting, refer to the instructions found + here. +

      c. Download files by using the following command, which references the manifest file name and its location:

      + + gen3-client download-multiple --profile=<profile_name> --manifest=<manifest_file> --download-path=<path_for_files>

      + + gen3-client download-multiple --profile=demo --manifest=manifest.json --download-path=downloads

      + + #Output:
      + + 2021/06/03 16:48:46 Reading manifest...
      + 200 B / 200 B [===================] 100.00% 0s
      + WARNING: flag "rename" was set to false in "original" mode, duplicated files under "downloads/" will be overwritten
      + Proceed? [y/n]: y
      + 2021/06/03 16:48:47 Total number of GUIDs: 1
      + 2021/06/03 16:48:47 Preparing file info for each file, please wait...
      + 1 / 1 [============================================] 100.00% 0s
      + 2021/06/03 16:48:47 File info prepared successfully
      + arcos_all_washpost.tsv.gz 6.41 GiB / 6.41 GiB [=======================================================] 100.00% 0s

      + + -
    12. + -

      a) Download Data Files using the Gen3-client

      In order to download data files above 250 MB, users will need to utilize the Gen3-client command line tool developed by the University of Chicago’s Center for Translational Data Science.

      - +

      Find below a guide to download data files using the Gen3-client:

      1. Log in to BRH on https://brh.data-commons.org/login. - + Link your accounts to FAIR repositories as described here.

      2. @@ -1717,22 +1800,22 @@

        a) Download Data Files usi


      3. Select a study and click on the button “Download". - +



    13. Create and download an API key from your Profile Page. Note where you save the API key on your local machine. - +

    14. @@ -1773,13 +1856,13 @@

      a) Download Data Files usi

    15. -
    + --> -

    b) Download Data Files in Workspaces using the Python SDK

    + + Link your accounts to FAIR repositories as described here.

  • @@ -1796,7 +1879,7 @@

    b) Download Data Files

  • Select a study and click on "Open in Workspace". - + +

  • @@ -1823,7 +1906,7 @@

    b) Download Data Files

  • Open a new terminal under "New". - workspace_terminal + workspace_terminal

  • @@ -1867,13 +1950,13 @@

    b) Download Data Files

  • - - -

    Contact

    +

    6. Contact

    - Need help? Please contact our help + Need help? Please contact our help desk.

    @@ -2114,4 +2197,4 @@

    Contact

    - \ No newline at end of file +