Skip to content

Describe SimBIDS in the README - #22

Merged
mattcieslak merged 1 commit into
PennLINC:mainfrom
asmacdo:readme-describe-simbids
Aug 19, 2026
Merged

mattcieslak merged 1 commit into
PennLINC:mainfrom
asmacdo:readme-describe-simbids

Conversation

@asmacdo

@asmacdo asmacdo commented Aug 13, 2026

Copy link
Copy Markdown
Contributor

I'm preparing to submit SimBIDS as an official BIDS App to the BIDS website's app list.

Before I do, I thought it would be prudent to make sure the README is useful. The old one was inherited template boilerplate describing a different tool. I ran the installation commands to confirm they work as written.

There are also docs/, which IMO could be deleted. (they're templated too, and AFAICT aren't useful or hosted anywhere.) Happy to remove them in a separate commit, or a separate PR if preferred.

The README was fmripost template boilerplate with "fmripost" replaced by
"SimBIDS", so it described a postprocessing workflow template: creating new
workflows by search-replacing the name, fMRIPrep --level full requirements,
AROMA output spaces, TemplateFlow transforms.  None of that is SimBIDS.

Describe what it does instead: simulate BIDS datasets and derivative trees
with real structure and no image content, via simbids-raw-mri and simbids.

Co-Authored-By: Claude Opus 5 (1M context) <noreply@anthropic.com>
@yarikoptic

Copy link
Copy Markdown

Just add those pointers to the container to https://github.com/bids-standard/bids-website/blob/main/data/tools/apps.yml

@yarikoptic

Copy link
Copy Markdown

@mattcieslak ping

@mattcieslak mattcieslak left a comment

Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thanks for fixing this @asmacdo!

@mattcieslak
mattcieslak merged commit 72a8a5c into PennLINC:main Aug 19, 2026
1 of 9 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants