Data

Tools

Indexes

Applications

Experiments

Open Source Science

https://github.com/aces/cbrain-cli

A command-line interface to the CBRAIN service

https://github.com/aces/cbrain-cli

Science Score: 26.0%

This score indicates how likely this project is to be science-related based on various indicators:

  • ○
    CITATION.cff file
  • ✓
    codemeta.json file
    Found codemeta.json file
  • ✓
    .zenodo.json file
    Found .zenodo.json file
  • ○
    DOI references
  • ○
    Academic publication links
  • ○
    Academic email domains
  • ○
    Institutional organization owner
  • ○
    JOSS paper metadata
  • ○
    Scientific vocabulary similarity
    Low similarity (14.4%) to scientific vocabulary
Last synced: 9 months ago · JSON representation

Repository

A command-line interface to the CBRAIN service

Basic Info
  • Host: GitHub
  • Owner: aces
  • License: mit
  • Language: Python
  • Default Branch: main
  • Size: 121 KB
Statistics
  • Stars: 1
  • Watchers: 3
  • Forks: 2
  • Open Issues: 5
  • Releases: 0
Created about 1 year ago · Last pushed 10 months ago
Metadata Files
Readme License

README.md

CBRAIN CLI

A command-line interface to a CBRAIN service

This repository contains a UNIX command-line interface (CLI) for CBRAIN.

The interface is implemented in Python using only standard libraries - no external dependencies required.

The main command is called "cbrain" and as is typical for such clients, works with a set of subcommand and options (e.g. "cbrain file list -j") such as: bash cbrain file list cbrain project show cbrain --json dataprovider list

CBRAIN Access Options

There are two main ways to access CBRAIN:

  1. McGill Production Portal (Recommended for Regular Users)

    • Access the McGill-supported CBRAIN production portal at: https://portal.cbrain.mcgill.ca/
    • No local installation required
    • Web-based interface for most common operations

  2. Custom/Development Setup

    • Deploy CBRAIN on your lab cluster, cloud, or virtual machine
    • Suitable for organizations wanting their own CBRAIN instance
    • Local installation only needed for:
      • CLI software developers
      • Power users developing/debugging custom CLI scripts
    • Follow setup instructions at CBRAIN GitHub Repository if you need a local instance

Installation

This CLI tool uses pure Python with no external library dependencies, making installation straightforward.

Option 1: Direct Usage

  1. Clone this repository: bash git clone https://github.com/aces/cbrain-cli.git cd cbrain-cli

  2. Run directly: bash ./cbrain --help # Make the cbrain script executable by `chmod +x cbrain`

Option 2: Virtual Environment

For isolated usage:

```bash

Create and activate virtual environment

python3 -m venv venv source venv/bin/activate # On Windows: venv\Scripts\activate pip install -e . ```

Initial Setup

After installation, you need to login to your CBRAIN instance:

bash cbrain login

When prompted for "Enter CBRAIN server URL prefix", enter: - For McGill Production Portal: https://portal.cbrain.mcgill.ca - For custom setup: Your CBRAIN instance URL

API Reference

This CLI interfaces with the CBRAIN REST API. For complete API documentation and specifications, refer to: - CBRAIN API Documentation (Swagger)

Development

This is part of a GSoC (Google Summer of Code) project sponsored by INCF.

The lead developer is axif0, mentored by the developers of the CBRAIN project.

License

See LICENSE file for details.

Owner

  • Name: ACElab
  • Login: aces
  • Kind: organization
  • Location: Montreal, Quebec, Canada

McGill Centre for Integrative Neuroscience (MCIN) - Alan C. Evans, Ph.D., Principal Investigator

GitHub Events

Total
  • Issues event: 17
  • Issue comment event: 18
  • Push event: 4
  • Pull request review comment event: 1
  • Pull request review event: 5
  • Pull request event: 13
  • Fork event: 1
Last Year
  • Issues event: 17
  • Issue comment event: 18
  • Push event: 4
  • Pull request review comment event: 1
  • Pull request review event: 5
  • Pull request event: 13
  • Fork event: 1

Issues and Pull Requests

Last synced: 9 months ago

All Time
  • Total issues: 11
  • Total pull requests: 7
  • Average time to close issues: 11 days
  • Average time to close pull requests: 3 days
  • Total issue authors: 2
  • Total pull request authors: 2
  • Average comments per issue: 0.36
  • Average comments per pull request: 0.29
  • Merged pull requests: 2
  • Bot issues: 0
  • Bot pull requests: 0
Past Year
  • Issues: 11
  • Pull requests: 7
  • Average time to close issues: 11 days
  • Average time to close pull requests: 3 days
  • Issue authors: 2
  • Pull request authors: 2
  • Average comments per issue: 0.36
  • Average comments per pull request: 0.29
  • Merged pull requests: 2
  • Bot issues: 0
  • Bot pull requests: 0
View more stats
Top Authors
Issue Authors
  • MontrealSergiy (10)
  • prioux (1)
Pull Request Authors
  • axif0 (5)
  • prioux (2)
Top Labels
Issue Labels
Priority: Low (4) documentation (2) bug (2) enhancement (1) refactoring (1)
Pull Request Labels

Dependencies

.github/workflows/capture_tests.yaml actions
  • actions/cache v3 composite
  • actions/checkout v4 composite
  • actions/upload-artifact v4 composite
  • ruby/setup-ruby v1 composite
  • mariadb * docker
setup.py pypi