Adding a Library¶

This guide covers adding an entirely new software library to niBuild (e.g., a new neuroimaging package not yet supported).

Step 1: Docker Image¶

Add the library's Docker image to DOCKER_IMAGES in src/utils/toolAnnotations.js:

export const DOCKER_IMAGES = {
    "fsl": "brainlife/fsl",
    "afni": "brainlife/afni",
    // ...
    "my_library": "dockerhub-user/my-library",  // ← add here
};

Step 2: Docker Tags¶

Add available version tags to DOCKER_TAGS:

export const DOCKER_TAGS = {
    // ...
    "My Library": [
        "latest",
        "1.0.0",
        "0.9.0",
    ],
};

The key must match how the library name appears in the menu (MODALITY_ASSIGNMENTS).

Step 3: Create CWL Directory¶

Create a subdirectory in public/cwl/ for the library:

public/cwl/my_library/
├── tool_a.cwl
├── tool_b.cwl
└── tool_c.cwl

Each CWL file should reference the Docker image from Step 1:

hints:
  DockerRequirement:
    dockerPull: dockerhub-user/my-library:latest

Step 4: Add Tool Annotations¶

Add entries for each tool in TOOL_ANNOTATIONS (see Adding a Tool for the full field reference).

Add the library to MODALITY_ASSIGNMENTS under the appropriate modality:

'Structural MRI': {
    FSL: { /* ... */ },
    'My Library': {
        'Category Name': ['tool_a', 'tool_b'],
        'Another Category': ['tool_c'],
    },
},

If the library spans multiple modalities, add it to each relevant modality section.

Step 6: Modality (Optional)¶

If the library requires a new imaging modality, add it to:

export const modalityOrder = [
    "Structural MRI", "Functional MRI", /* ... */,
    "My New Modality",  // ← add here
];

export const modalityDescriptions = {
    // ...
    "My New Modality": "Description of the imaging modality.",
};

Verification¶

npm run dev — verify tools appear in the correct modality/library section
Check Docker version dropdown shows the tags from Step 2
Build and export a test workflow using the new tools
Validate the exported CWL: cwltool --validate workflows/test.cwl