BIDScycle
This project is a BIDS compatible tool for easy renaming of BIDS data.
Getting Started
To get started simply install using:
pip install bidscycle
or
pip install git+https://github.com/miltoncamacho/BIDScycle.git@main
for the bleading edge latest changes
Usage
usage: bidscycle [-h] {create-duplicates,switch-duplicate,clean-duplicates}
You will need to select from the different commands to perform:
create-duplicates
This command will help you create BIDS duplicates in any of the files that match the provided BIDS compatible filters.
usage: bidscycle create-duplicates [-h] -f entity=value[,value2] [--commit-msg COMMIT_MSG] [--dry-run] [--no-datalad] [-v] dataset
| Argument | Description |
|---|---|
dataset |
Absolute path to the dataset containing sub-XX folders. |
--filter,-f |
Entity filter in the format entity=value[,value2]. |
--commit-msg |
Optional commit message for saving the changes. |
--dry-run |
Perform a trial run without making any changes. |
--no-datalad |
Skip Datalad commands during execution. |
-v |
Enable verbose output for debugging purposes. |
switch-duplicates
usage: bidscycle switch-duplicates [-h] -f entity=value[,value2] [--commit-msg COMMIT_MSG] [--dry-run] [--no-datalad] [-v] dataset
| Argument | Description |
|---|---|
dataset |
Absolute path to the dataset containing sub-XX folders. |
--filter,-f |
Entity filter in the format entity=value[,value2] must contain dup. |
--commit-msg |
Optional commit message for saving the changes. |
--dry-run |
Perform a trial run without making any changes. |
--no-datalad |
Skip Datalad commands during execution. |
-v |
Enable verbose output for debugging purposes. |
switch-duplicates
usage: bidscycle clean-duplicates [-h] [-f entity=value[,value2]] --keep_pattern N[,N2] [--commit-msg COMMIT_MSG] [--dry-run] [--no-datalad] [-v] dataset
| Argument | Description |
|---|---|
dataset |
Absolute path to the dataset containing sub-XX folders. |
--filter,-f |
Entity filter in the format entity=value[,value2]. |
--keep_pattern |
Pattern(s) to keep (comma‑separated; e.g., '__dup-01'). |
--commit-msg |
Optional commit message for saving the changes. |
--dry-run |
Perform a trial run without making any changes. |
--no-datalad |
Skip Datalad commands during execution. |
-v |
Enable verbose output for debugging purposes. |
Metadata
Release files for BIDScycle 0.0.2
For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.
Source distribution (sdist)
| File | Size | Uploaded | |
|---|---|---|---|
| bidscycle-0.0.2.tar.gz | 12.4 kB | Details |
Built distribution (wheel)
| File | Interpreter | ABI | Platform | Reset |
|---|---|---|---|---|
| bidscycle-0.0.2-py3-none-any.whl | Python 3 | none | any | Details |
Total release size: 27.3 kB
Release files / bidscycle-0.0.2.tar.gz
| Download URL | bidscycle-0.0.2.tar.gz |
|---|---|
| Size | 12.4 kB |
| Tags | Source |
|
SHA-256 checksum How to use checksums |
22e84a64288381edf61882230faffad2be4ccf33b3c8c8b9bb76b7d484f242fd
|
|
BLAKE2b-256 checksum How to use checksums |
e5b6e934a6a14d6e2fad07ca8ecdf83aa530fcf11c7aa9569f619c05dbb1106d
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
| Uploaded via |
twine/6.1.0 CPython/3.11.12
|
Release files / bidscycle-0.0.2-py3-none-any.whl
| Download URL | bidscycle-0.0.2-py3-none-any.whl |
|---|---|
| Size | 14.9 kB |
| Tags | Python 3 |
|
SHA-256 checksum How to use checksums |
92523560dc116ad3fada6f27eefcf50a40ee020bee38bd12f57fce7ea3111855
|
|
BLAKE2b-256 checksum How to use checksums |
f2b14e283bbe6599a901e18677347aff9c5f3a7b56c7060eab7de4f6844ee2b0
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
| Uploaded via |
twine/6.1.0 CPython/3.11.12
|