Reference
PachCTL

User Guide

Learn how to use the JupyterLab Mount Extension with Pachyderm.

March 22, 2023

Select a Project #

You can filter mountable repositories by selecting a project.

  1. Open the JupyterLab UI.
  2. Navigate to the Project dropdown.
  3. Select an existing project or the default project.

project select

Create a Repo & Repo Branch #

  1. Open the JupyterLab UI.

  2. Open a Terminal from the launcher.

  3. Input the following:

    pachctl create repo demo
    pachctl create branch demo@master
  4. Check the Unmounted Repositories section.

create repo and branch

💡

Your repo is created within the project set to your current context.

Mount a Repo Branch #

  1. Open the JupyterLab UI.
  2. Navigate to the Unmounted Repositories section.
  3. Scroll to a repository’s row.
  4. Select Mount.

mount repo

Mount (and Test) a Datum #

You can mount to a specific datum in your repository from the JupyterLab UI using an input spec. This is useful when:

  1. Open the JupyterLab UI.

  2. Mount to a repo from the Unmounted Repositories section. (e.g., mounting to demo would look like /pfs/demo/ in the file browser).

  3. Navigate to the Mounted Repositories section and select Datum.

    mount and test datums

    You should see the following:

    pfs:
       repo: demo
       branch: master
       glob: / 
  4. Update the glob pattern to match the datums you wish to focus on.

    Directory Example #
    pfs:
       repo: demo
       branch: master
       glob: /images/2022/*
    Extension Example #
    pfs:
       repo: demo
       branch: master
       glob: /images/**.png
  5. Select Mount Datums.

  6. The file browser updates to display the matching datums.

When you return to the mounted view by selecting Back, the file browser will return to displaying datums that match your default glob pattern.

Explore Directories & Files #

At the bottom of the Mounted Repositories tab, you’ll find the file browser.

Using the previous example, while the Demo repository is mounted, you can select the demo folder to reveal the example myfile.txt.