-
Notifications
You must be signed in to change notification settings - Fork 6
[DOC] Update with the latest usage guide + missing metrics #126
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Merged
Merged
Changes from all commits
Commits
Show all changes
15 commits
Select commit
Hold shift + click to select a range
32919be
Update contribution guide
mathdugre 24938da
Update installation instructions
mathdugre 7653141
Update repo URL
mathdugre e3630c1
Fix wrong year for Dec 2025 rel
mathdugre 876578d
Update section headers
mathdugre 0e6dabd
Remove search page.
mathdugre f4d1af6
Update with most recent guide from @claraElk
mathdugre c48720e
Update readme to mimick usage quickstart guide.
mathdugre 88a5d1f
Update linter badge to `ruff`.
mathdugre a3b605b
Include all columns description from the metrics.tsv file
mathdugre 3bd2040
Add glossary
mathdugre 8f026fb
Fix typos and minor inacuracies
mathdugre 2df8f55
Add references
mathdugre ea4a292
Update dependencies to require myst-parser >= 5.1.0
mathdugre c865a81
Make datalad command more general when fetching test data.
mathdugre File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,2 @@ | ||
| # Citations | ||
| Sepulcre |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1,19 +1,33 @@ | ||
| [](https://results.pre-commit.ci/latest/github/HALFpipe/wonkyconn/main) | ||
| [](https://opensource.org/licenses/MIT) | ||
|  | ||
| [](https://github.com/astral-sh/ruff) | ||
| [](https://wonkyconn.readthedocs.io/en/latest/?badge=latest) | ||
|
|
||
| # wonkyconn | ||
|
|
||
| Evaluating the residual motion and analytic insights on fMRI connectome and visualise reports. | ||
| Wonkyconn evaluates residual motion and analytic quality in group-level fMRI connectomes and creates visualization reports to compare the generated metrics. | ||
|
|
||
| The project is based on the code of [`SIMEXP/fmriprep-denoise-benchmark`](https://github.com/SIMEXP/fmriprep-denoise-benchmark) and the publication by [Wang et al. 2024](http://dx.doi.org/10.1371/journal.pcbi.1011942). | ||
|
|
||
| **This project is in alpha stage! This is not a stable project yet.** | ||
|
|
||
| ## Quick start | ||
|
|
||
| Recommended container: | ||
|
|
||
| ```bash | ||
| apptainer build wonkyconn-edge.sif docker://halfpipe/wonkyconn:edge | ||
| ``` | ||
|
|
||
| See the [documentation](https://wonkyconn.readthedocs.io/en/latest/) for usage, methods, and outputs. | ||
|
|
||
| ## Textual GUI (optional) | ||
|
|
||
| - Install the optional dependency: `pip install "wonkyconn[textual]"`. | ||
| - Launch the GUI instead of running headless: `wonkyconn --textual`. | ||
| - The GUI requires an interactive terminal (TTY). If you are running inside a non-interactive job (for example, on an HPC batch node), run the CLI without `--textual` instead. | ||
| - All required inputs are collected in the GUI; existing CLI defaults and behaviour are preserved once you click **Run**. | ||
| - Install: `pip install "wonkyconn[textual]` | ||
| - Launch: `wonkyconn --textual` | ||
| - The CLI is required for headless batch jobs or multi-atlas runs. | ||
|
|
||
| > [!WARNING] | ||
| > | ||
| > - The textual UI requires an interactive terminal (TTY) if you are running Wonkyconn inside a non-interactive terminal (e.g., HPC batch job), use the CLI with `--textual`. | ||
| > - Current GUI supports one atlas entry. Use the CLI for multi-atlas runs. |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
|
|
@@ -53,7 +53,7 @@ | |
|
|
||
| ## 25.12.0-alpha | ||
|
|
||
| **Released December 2026** | ||
| **Released December 2025** | ||
|
|
||
| ### New | ||
|
|
||
|
|
||
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Oops, something went wrong.
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Uh oh!
There was an error while loading. Please reload this page.