Skip to content

Commit 43f7be7

Browse files
committed
adriatic edition updates
1 parent 9279d91 commit 43f7be7

1 file changed

Lines changed: 151 additions & 1 deletion

File tree

  • education/HADDOCK3/HADDOCK3-antibody-antigen

education/HADDOCK3/HADDOCK3-antibody-antigen/index.md

Lines changed: 151 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -213,8 +213,86 @@ This tutorial was last tested using HADDOCK3 version 2024.10.0b7. The provided p
213213

214214

215215
<hr>
216+
217+
### BioExcel Adriatic edition 2026, Ljubljana, Slovenia
218+
219+
You can either:
220+
221+
* make use of the ADD HPC system for this tutorial, working at the command line,
222+
* or [start a Colab notebook](https://colab.research.google.com/github/haddocking/haddock3/blob/main/notebooks/HADDOCK3-antibody-antigen.ipynb){:target="_blank"} (provided you have Google credentials) and follow the instructions in that notebook (simpler).
223+
224+
225+
If running on HPC system, the software and data required for this tutorial have been pre-installed.
226+
Please connect to the HPC system using your credentials either via ssh connection.
227+
228+
In order to run the tutorial, go into you data directory, then copy and unzip the required data:
229+
230+
<a class="prompt prompt-cmd">
231+
unzip /home/vreys/HADDOCK3-antibody-antigen.zip
232+
</a>
233+
234+
This will create the `HADDOCK3-antibody-antigen` directory with all necessary data and scripts and job examples ready for submission to the batch system.
235+
236+
HADDOCK3 has been pre-installed on the compute nodes.
237+
To test the installation, first create an interactive session on a node with:
238+
239+
240+
<a class="prompt prompt-cmd">
241+
salloc --job-name=interactive_haddock3 --partition=amd --nodes=1 --cpus-per-task=8 --time-min=120
242+
</a>
243+
244+
Once the session is active, activate HADDOCK3 with:
245+
246+
<a class="prompt prompt-cmd">
247+
source /home/vreys/haddock3/.haddock-env/bin/activate
248+
<br>
249+
</a>
250+
251+
You can then test that `haddock3` is indeed accessible with:
252+
253+
<a class="prompt prompt-cmd">
254+
haddock3 -h
255+
</a>
256+
257+
You should see a small help message explaining how to use the software.
258+
259+
<details style="background-color:#DAE4E7">
260+
<summary>
261+
<i>View output</i><i class="material-icons">expand_more</i>
262+
</summary>
263+
<pre>
264+
(haddock3)$ haddock3 -h
265+
usage: haddock3 [-h] [--restart RESTART] [--extend-run EXTEND_RUN] [--setup]
266+
[--log-level {DEBUG,INFO,WARNING,ERROR,CRITICAL}] [-v]
267+
recipe
268+
269+
positional arguments:
270+
recipe The input recipe file path
271+
272+
optional arguments:
273+
-h, --help show this help message and exit
274+
--restart RESTART Restart the run from a given step. Previous folders from the
275+
selected step onward will be deleted.
276+
--extend-run EXTEND_RUN
277+
Start a run from a run directory previously prepared with the
278+
`haddock3-copy` CLI. Provide the run directory created with
279+
`haddock3-copy` CLI.
280+
--setup Only setup the run, do not execute
281+
--log-level {DEBUG,INFO,WARNING,ERROR,CRITICAL}
282+
-v, --version show version
283+
</pre>
284+
</details>
285+
<br>
286+
287+
<hr>
288+
216289
### ASM 2026 HPC/AI school, Kobe, Japan, February 2026
217290

291+
292+
<details>
293+
<summary style="font-weight:bold; cursor:pointer;">
294+
<i>click to expand</i>
295+
</summary>
218296
You can either:
219297

220298
* make use of the Fugaku supercomputer for this tutorial, working at the command line,
@@ -286,11 +364,12 @@ optional arguments:
286364
</pre>
287365
</details>
288366
<br>
289-
367+
</details>
290368
<hr>
291369

292370

293371
### BioExcel summerschool, Pula, Sardinia June 2025
372+
294373
<details>
295374
<summary style="font-weight:bold; cursor:pointer;">
296375
<i>click to expand</i>
@@ -359,6 +438,7 @@ optional arguments:
359438

360439

361440
### Local setup (on your own)
441+
362442
<details>
363443
<summary style="font-weight:bold; cursor:pointer;">
364444
<i>click to expand</i>
@@ -1239,6 +1319,76 @@ This run should take about 25 minutes to complete on a single node using 48 arm
12391319

12401320
</details>
12411321

1322+
<hr>
1323+
1324+
#### Execution of HADDOCK3 on ADD Ljubljana (BioExcel Adriatic edition 2026, Ljubljana, Slovenia)
1325+
1326+
To execute the workflow, you can either start an interactive session or create a job file that will execute HADDOCK3 on a node,
1327+
with HADDOCK3 running in local mode (the setup in the above configuration file with <i>mode="local"</i>) and harvesting all core of that node (<i>ncores=16</i>).
1328+
<br>
1329+
<br>
1330+
<b>Start an interactive session on a node:</b>
1331+
<br>
1332+
{% highlight shell %}
1333+
salloc --job-name=interactive_haddock3 --partition=amd --nodes=1 --cpus-per-task=16 --time-min=120
1334+
{% endhighlight %}
1335+
1336+
Once the session is active, activate HADDOCK3 with:
1337+
1338+
{% highlight shell %}
1339+
source /home/vreys/haddock3/.haddock3-env/bin/activate<br>
1340+
{% endhighlight %}
1341+
1342+
You can then follow the tutorial and run all the commands present in it, such as starting a haddock3 docking workflow with:
1343+
1344+
{% highlight shell %}
1345+
haddock3 ./workflows/docking-antibody-antigen.cfg
1346+
{% endhighlight %}
1347+
<b>Job submission to the batch system:</b>
1348+
<br>
1349+
<br>
1350+
For this execution mode you should create an execution script contain specific requirements for the queueing system and the HADDOCK3 configuration and execution.
1351+
Here is an example of such an execution script (that can be saved under the name <i>run-haddock3-slurm.sh</i>):
1352+
1353+
{% highlight shell %}
1354+
#!/bin/bash
1355+
#SBATCH --partition=amd
1356+
#SBATCH --job-name=haddock3_run
1357+
#SBATCH --nodes=1
1358+
#SBATCH --cpus-per-task=16
1359+
#SBATCH --time-min=120
1360+
#SBATCH --output="haddock3_run_log.txt"
1361+
1362+
# Source the environement
1363+
source /home/vreys/haddock3/.haddock3-env/bin/activate
1364+
1365+
# Go to the appropriate directory
1366+
cd ~/HADDOCK3-antibody-antigen
1367+
1368+
# Launch haddock3
1369+
haddock3 workflows/docking-antibody-antigen.cfg
1370+
1371+
1372+
{% endhighlight %}
1373+
1374+
This file should be submitted to the batch system using the <i>sbatch</i> command:
1375+
1376+
{% highlight shell %}
1377+
sbatch run-haddock3-slurm.sh
1378+
{% endhighlight %}
1379+
1380+
<br>
1381+
1382+
And you can check the status in the queue using <i>squeue -u Username</i>.
1383+
1384+
Also, you can follow the state of your run by looking a the content of either the log file or the slurm output using:
1385+
1386+
{% highlight shell %}
1387+
tail -f haddock3_run_log.txt
1388+
{% endhighlight %}
1389+
1390+
This run should take around 20 minutes to complete on a single node using 16 arm cores.
1391+
12421392

12431393
<hr>
12441394

0 commit comments

Comments
 (0)