neuralfetch.utils.root_study_folder¶

neuralfetch.utils.root_study_folder(name: str | None = None, test_folder: Path | None = None) → Path[source][source]¶

Return the root folder where study data is stored.

Example

>>> folder = neuralfetch.utils.root_study_folder()
>>> study = ns.Study(name="Allen2022Massive", path=folder)

Built-in test/sample studies use ns.CACHE_FOLDER (or test_folder). All others require NEURALSET_STUDY_FOLDER env var.