Skip to content

Commit 8251e95

Browse files
committed
Restore index.rst to working version with complete documentation structure
1 parent 3be4250 commit 8251e95

File tree

1 file changed

+25
-0
lines changed

1 file changed

+25
-0
lines changed

docs/source/index.rst

Lines changed: 25 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -39,7 +39,9 @@ Quick Start
3939

4040
Surface Visualization
4141
=====================
42+
4243
.. code-block:: python
44+
4345
import clabtoolkit.surfacetools as cltsurf
4446
4547
# Reading a surface file
@@ -52,6 +54,29 @@ Surface Visualization
5254
cmap= "jet",
5355
colorbar_position="right")
5456
57+
58+
Working with FreeSurfer
59+
=======================
60+
.. code-block:: python
61+
62+
import clabtoolkit.freesurfertools as cltfree
63+
64+
# Get the FREESURFER_HOME environment variable
65+
freesurfer_home = os.environ.get('FREESURFER_HOME')
66+
67+
# Get the default subject directory
68+
fs_subject_dir = os.path.join(freesurfer_home, 'subjects')
69+
70+
fs_fullid = 'bert'
71+
72+
# Load the Subject object
73+
subject = cltfree.FreeSurferSubject(fs_fullid, fs_subject_dir)
74+
75+
# Print subject details
76+
print(f"Subject ID: {subject.subj_id}")
77+
print(f"Subject Directory: ")
78+
cltmisc.print_dict_tree(subject.fs_files)
79+
5580
API Reference
5681
=============
5782

0 commit comments

Comments
 (0)