Skip to main content

GUI application to manage BIDS datasets

Project description

BIDS Manager

BIDS Manager is a PyQt-based GUI that converts DICOM folders into BIDS-compliant datasets and allows easy metadata editing.


Requirements

Software Minimum Version Notes
Python 3.10 Installed automatically if you use the one-click installers
Git Must be installed manually (see below)

Installing Git

Platform Command / Action
Windows Download and run the installer: https://git-scm.com/download/win
Ubuntu/Debian sudo apt-get update && sudo apt-get install git

Installation

You can install BIDS Manager in two ways:

1. One-click installers (recommended)

  1. Download the ZIP package:
    📦 One-click Installers
  2. Extract the ZIP file and run the script for your operating system:
OS Script How to Run Duration
Windows 10/11 install_bids_manager.bat Double-click ≈ 5 min
Linux install_bids_manager.sh ./install_bids_manager.sh ≈ 5 min
  1. After the installation finishes, you will find two shortcuts on your desktop:
OS Launch Uninstall
Windows run_bidsmanager.bat uninstall_bidsmanager.bat
Linux BIDS Manager (launcher) uninstall_bidsmanager.sh

2. Install in a virtual environment (advanced)

# 1. Create a virtual environment
python3 -m venv <env_name>

# 2. Activate it
source <env_name>/bin/activate          # On Windows: <env_name>\Scripts\activate

# 3. Install BIDS Manager from GitHub
pip install git+https://github.com/ANCPLabOldenburg/BIDS-Manager.git

The package declares all dependencies including heudiconv, so installation pulls everything required to run the GUI and helper scripts. All core requirements are version pinned in pyproject.toml to ensure consistent installations.

After installation the following commands become available:

  • bids-manager – main GUI combining conversion and editing tools
  • dicom-inventory – generate subject_summary.tsv from a DICOM directory
  • build-heuristic – create a HeuDiConv heuristic from the TSV
  • run-heudiconv – run HeuDiConv using the generated heuristic
  • post-conv-renamer – rename fieldmap files after conversion
  • bids-editor – standalone metadata editor
  • fill-bids-ignore – interactively update .bidsignore

All utilities provide -h/--help for details.

Recent updates

  • The TSV produced by dicom-inventory can now be loaded directly in the GUI and its file name customised before generation.
  • The Batch Rename tool previews changes and allows restricting the scope to specific subjects.
  • A "Set Intended For" dialog lets you manually edit fieldmap IntendedFor lists if the automatic matching needs adjustment.
  • run-heudiconv now keeps a copy of subject_summary.tsv under .bids_manager and generates a clean participants.tsv using demographics from that file.
  • Re-running run-heudiconv on the same dataset now appends new subjects to the existing .bids_manager records and updates participants.tsv instead of overwriting them.
  • dicom-inventory distinguishes repeated sequences by adding series_uid and rep columns and records acq_time for each series in subject_summary.tsv.
  • Fieldmap rows for magnitude and phase images are now merged so each acquisition appears once with the combined file count, and their series_uid values are stored as a pipe-separated list so both sequences are converted.
  • post-conv-renamer now adds an IntendedFor list to each fieldmap JSON so fMRI preprocessing tools can automatically match fieldmaps with the relevant functional runs.
  • The GUI's Tools menu gained actions to refresh _scans.tsv files and edit .bidsignore entries.
  • The DPI scale dialog now adjusts values in 25% increments and the DPI button appears between the CPU and Authorship buttons.
  • On startup the GUI detects the system DPI and applies the matching scale.
  • The scanned data table now provides a "Generate unique IDs" button that assigns random 3‑letter/3‑digit identifiers to subjects. If an entry already exists for the same study in an existing .bids_manager/subject_summary.tsv, you are prompted to reuse its identifier.
  • A "Detect repeats" button can recompute repetition numbers based on acquisition time when all BIDS and given names are filled.

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

bids_manager-0.1.0.tar.gz (446.4 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

bids_manager-0.1.0-py3-none-any.whl (446.1 kB view details)

Uploaded Python 3

File details

Details for the file bids_manager-0.1.0.tar.gz.

File metadata

  • Download URL: bids_manager-0.1.0.tar.gz
  • Upload date:
  • Size: 446.4 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.1.0 CPython/3.10.12

File hashes

Hashes for bids_manager-0.1.0.tar.gz
Algorithm Hash digest
SHA256 b2071b866ffbb8e59c610b4699913f45f7024eaf3f2efd16162a1c316e565f1a
MD5 7de4ac88e8e2761788c688ce408015f1
BLAKE2b-256 9f9849d8fbd7b3c77d03268b3e84dcb73d7e9e63a6a1e159c4af9f56a9188d33

See more details on using hashes here.

File details

Details for the file bids_manager-0.1.0-py3-none-any.whl.

File metadata

  • Download URL: bids_manager-0.1.0-py3-none-any.whl
  • Upload date:
  • Size: 446.1 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.1.0 CPython/3.10.12

File hashes

Hashes for bids_manager-0.1.0-py3-none-any.whl
Algorithm Hash digest
SHA256 23f747fc36038801d5c758485ec4d7789ec777236ade3446a30dd863594fd8cf
MD5 17a38a662b9699887b962e1d2c93a25b
BLAKE2b-256 4fd02618060643a1d8ebf7f84cc6950288883dd023e05a70d736dabc7b6b24ff

See more details on using hashes here.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page