Skip to content

brain-bbqs/bbqs-sink

Folders and files

NameName
Last commit message
Last commit date

Latest commit

Β 

History

4 Commits
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 

Repository files navigation

BBQS Utility 'Sink'

This is a central repository for the BBQS consortium to use to consolidate code snippets and scripts that might be 'generally useful' for others.

There is no limit to the types of code that can be added, but we request them to be as modular as possible.

Organization

Each utility is encapsulated as a BIDS Study style collection (regardless of whether your data is truly BIDS compliant).

That is, each capsule follows the structure:

[utility-identifier]/
β”œβ”€β”€ code/
β”‚   β”œβ”€β”€ [script1].py
β”‚   β”œβ”€β”€ [script2].py
β”‚   └── ...
β”œβ”€β”€ data/
β”‚   β”œβ”€β”€ [example_data1]
β”‚   └── ...
β”œβ”€β”€ CHANGES.md
└── README.md

All utilities should have descriptive README.md file that explains the purpose, usage, and any necessary instructions for running the code. The use of in-code docstrings is also highly encouraged. You may also include a CHANGES.md file to track any updates or modifications made to the code over time.

Including very small amounts of sample data to demonstrate intended usage is encouraged, but not required. Designing and using a small test suite to validate the functionality of the code using this sample data is also encouraged, but not required.

About

This is a central repository for the BBQS consortium to use to consolidate code snippets and scripts that might be 'generally useful' for others.

Resources

License

Stars

Watchers

Forks

Contributors

Languages