rdmtools/README.md
Michael Hanke 762636df09
feat: ni_mannheim tooling
ATM this is just a minimally modified copy of `bif_mannheim`.
It is ready to run, but will see further adjustments.
2026-01-16 19:28:15 +01:00

1.8 KiB

TRR379 RDM tools

Tools

These tools provide their functionality via several subcommands. They are fully documented in the tool itself. Run with --help, or <subcommand> --help to learn about the provided functionality.

bif_aachen

Utility for interacting with the TRR379 RDM system at the brain imaging facility (BIF) in Aachen.

This tool can be used without a dedicated installation step. Using uv, it can be executed directly from the TRR379 hub. To run the latest version, execute:

uv run https://hub.trr379.de/q02/rdmtools/raw/branch/main/trr379_rdmtools/bif_aachen.py

ni_mannheim

Utility for interacting with the TRR379 RDM system at the neuroimaging unit in Mannheim.

This tool can be used without a dedicated installation step. Using uv, it can be executed directly from the TRR379 hub. To run the latest version, execute:

uv run https://hub.trr379.de/q02/rdmtools/raw/branch/main/trr379_rdmtools/ni_mannheim.py

Recommendations

Some operations make frequent requests to the TRR379 hub. It is infeasible to run them without credential caching -- in particular with enabled two-factor authentication. It is therefore recommended to:

  • set up an access token at https://hub.trr379.de/user/settings/applications (with repository read/write permissions, including private repositories)

  • enable credential caching for a user account via running:

    git config --global credential.helper cache
    git config --global credential.helper 'cache --timeout=3600'
    

    This configures credentials to be cached for maximum one hour.

Acknowledgements

This work was funded by Deutsche Forschungsgemeinschaft (DFG, German Research Foundation) under grant TRR379 (546006540, Q02 project)