Skip to content
OHBA-analysisPublic

About

Files used by the OHBA Software Library (OSL).

Resources

Stars

0 stars

Watchers

0 watching

Forks

Repository files navigation

OHBA Software Library (OSL) Files

Data files used by the OHBA Software Library (OSL): brain parcellations, MNI152 templates and masks, cortical surfaces, MEG scanner layouts and Workbench scenes.

Layout

Directory Contents
parcellation/ Volumetric brain parcellations (AAL, Desikan-Killiany, Giles, Glasser, Schaefer, Harvard-Oxford subcortical). Labels, MNI coordinates and pictures for each one are in docs/parcellations. legacy/ keeps files older osl-ephys analyses used, under their original names.
mask/ MNI152 brain masks at several resolutions
surface/32k_fs_LR/ Cortical surface meshes for plotting
surface/mni152/ Pre-extracted MNI152 skull and scalp surfaces, for use with RHINO when no subject MRI is available
scanner/ MEG scanner layouts and channel names (CTF-275, Neuromag-306), and a Neuromag-306 template info for simulations
simulation/ MVAR model parameters fitted to resting-state Neuromag-306 data, for simulating sensor-space MEG
scene/ HCP Workbench scene files
test_data/ Short M/EEG recordings for testing (Elekta, CTF, OPM, EEG): real sensor geometry with a synthetic signal, see test_data/README.md

Where they are cached

Platform Location
macOS ~/Library/Caches/osl-files/
Linux and WSL $XDG_CACHE_HOME/osl-files/, falling back to ~/.cache/osl-files/
Windows %LOCALAPPDATA%\osl-files\Cache\

Set the OSL_DATA environment variable to cache them somewhere else, for example on a cluster where your home directory has a quota, or to point a whole group at one read-only copy.

Each download is checked against a checksum, so a file is only fetched once and a truncated or corrupted one is caught rather than passed on to the analysis.

To fetch everything up front, for a machine that will later be offline, run the download command of whichever package you use somewhere with network access and copy the cache across.

Packages that use these files

Package Download command
osl-dynamics osl-dynamics-download-data
osl-ephys osl-ephys-download-data (from v3)

Adding or changing files

Add, change or remove the file here and open a pull request. That is the whole procedure: registry.txt lists every data file with its SHA-256 checksum, and is regenerated automatically on every push to main by the Registry workflow. The packages download that registry at runtime, so a change here reaches users on their next run without any package needing to be released.

The checksum is also what refreshes a cache. Change a file's contents and its checksum changes, so anyone holding the old copy downloads the new one; leave it alone and nobody re-downloads anything.

Renaming or moving a file is the one thing to be careful with, since already released packages ask for files by path. Prefer adding a new file under a new name, and remove the old one only once no supported release still fetches it.

About

Files used by the OHBA Software Library (OSL).

Resources

Stars

0 stars

Watchers

0 watching

Forks

Contributors

Languages