Skip to content

Commit 4c5b780

Browse files
committed
docs(notebook): expose --shape / --reach / --probe in maws.ipynb
The CLI driver notebook had no surface for the three new sampling flags. Added: - A markdown cell explaining what shape, reach, and probe mean for the new surface-aware sampler (with the rule of thumb for each default). - shape / reach / probe parameter assignments in both the commented template parameter cell and the active parameter cell. - --shape / --reach / --probe flags appended to the corresponding CLI invocation cells. Defaults match the CLI: shape=shell, reach=10.0, probe=1.4.
1 parent 01dcaf2 commit 4c5b780

1 file changed

Lines changed: 45 additions & 5 deletions

File tree

notebooks/maws/maws.ipynb

Lines changed: 45 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -49,6 +49,22 @@
4949
"You can edit the following cell and change the parameters to run the MAWS program"
5050
]
5151
},
52+
{
53+
"cell_type": "markdown",
54+
"id": "7fb27b941602401d91542211134fc71a",
55+
"metadata": {},
56+
"source": [
57+
"### Surface-aware sampling parameters (new in 2026)\n",
58+
"\n",
59+
"MAWS now restricts the initial pose search to the region just outside the ligand surface, computed from the ligand atoms automatically. Three knobs:\n",
60+
"\n",
61+
"- **`shape`** — geometry of the search envelope around the ligand. `shell` (default) hugs the surface most tightly; `sphere` is a simple bounding sphere; `cube` is the bounding box.\n",
62+
"- **`reach`** — how far past the ligand surface the envelope extends, in ångströms. Roughly the distance an aptamer atom can sit beyond the protein. Default `10.0` Å — about one nucleotide's worth of slack.\n",
63+
"- **`probe`** — radius of the rolling probe used to define the SAS surface, in ångströms. A candidate pose is rejected if any aptamer atom would land within `vdW(atom) + probe` of any protein atom. Default `1.4` Å (water-equivalent, the convention used by Chimera/PyMOL/FreeSASA).\n",
64+
"\n",
65+
"Keep the defaults unless your target is unusual (very small ligand, very deep pocket, etc.).\n"
66+
]
67+
},
5268
{
5369
"cell_type": "code",
5470
"execution_count": null,
@@ -81,7 +97,16 @@
8197
"# chunk_1 = 5000\n",
8298
"\n",
8399
"# # Second chunk size (default: 5000)\n",
84-
"# chunk_2 = 5000"
100+
"# chunk_2 = 5000\n",
101+
"\n",
102+
"# # Sampling envelope shape: cube | sphere | shell (default: shell)\n",
103+
"# shape = \"shell\"\n",
104+
"\n",
105+
"# # How far the envelope extends beyond the ligand surface, in Å (default: 10)\n",
106+
"# reach = 10.0\n",
107+
"\n",
108+
"# # vdW probe radius for SAS rejection, in Å (default: 1.4, water-like)\n",
109+
"# probe = 1.4\n"
85110
]
86111
},
87112
{
@@ -99,7 +124,10 @@
99124
"# --moleculetype \"{mol_type}\" \\\n",
100125
"# --beta {beta} \\\n",
101126
"# --firstchunksize {chunk_1} \\\n",
102-
"# --secondchunksize {chunk_2}"
127+
"# --secondchunksize {chunk_2} \\\n",
128+
"# --shape {shape} \\\n",
129+
"# --reach {reach} \\\n",
130+
"# --probe {probe}\n"
103131
]
104132
},
105133
{
@@ -134,7 +162,16 @@
134162
"chunk_1 = 5000\n",
135163
"\n",
136164
"# Second chunk size (default: 5000)\n",
137-
"chunk_2 = 5000"
165+
"chunk_2 = 5000\n",
166+
"\n",
167+
"# Sampling envelope shape: cube | sphere | shell (default: shell)\n",
168+
"shape = \"shell\"\n",
169+
"\n",
170+
"# How far the envelope extends beyond the ligand surface, in Å (default: 10)\n",
171+
"reach = 10.0\n",
172+
"\n",
173+
"# vdW probe radius for SAS rejection, in Å (default: 1.4, water-like)\n",
174+
"probe = 1.4"
138175
]
139176
},
140177
{
@@ -155,7 +192,10 @@
155192
" --secondchunksize {chunk_2} \\\n",
156193
" --clean-pdb \\\n",
157194
" --remove-h \\\n",
158-
" --drop-hetatm"
195+
" --drop-hetatm \\\n",
196+
" --shape {shape} \\\n",
197+
" --reach {reach} \\\n",
198+
" --probe {probe}"
159199
]
160200
},
161201
{
@@ -188,4 +228,4 @@
188228
},
189229
"nbformat": 4,
190230
"nbformat_minor": 5
191-
}
231+
}

0 commit comments

Comments
 (0)