Attention: The EBRAINS IDM/IAM will be down tomorrow, Wednesday 17nd December, from 17:00 CET for up to 30 minutes for maintenance. Please be aware that this will affect all services that require login or authentication.


Last modified by teodoramisan on 2025/12/15 16:59
From version 45.1
edited by paulapopa
on 2023/03/08 16:30
Change comment: There is no comment for this version
To version 60.1
edited by teodoramisan
on 2025/12/15 16:59
Change comment: There is no comment for this version

Summary

Details

Page properties
Author
... ... @@ -1,1 +1,1 @@
1 -XWiki.paulapopa
1 +XWiki.teodoramisan
Content
... ... @@ -2,13 +2,17 @@
2 2  
3 3  Release on Pypi: [[https:~~/~~/pypi.org/project/tvb-ext-xircuits/>>https://pypi.org/project/tvb-ext-xircuits/]]
4 4  
5 -== Jupyter Lab Extension for building and executing EBRAINS Workflows ==
5 +This extension is also installed already in EBRAINS lab, where it can be tested directly.
6 6  
7 +== Jupyter Lab Extension for building and executing TVB Workflows on EBRAINS ==
8 +
7 7  == Purpose ==
8 8  
9 9  This is a Jupyter Lab extension that offers graphical support for TVB workflows. It is already available in the EBRAINS Lab and it allows users to configure and execute TVB simulations directly from a GUI, while drastically reducing the complexity of configuring them inside a Jupyter Lab notebook.
10 10  
11 -**Note: **This extension is still a WIP (Work In Progress).
13 +{{html}}
14 +<iframe width="1200" height="450" src="https://www.youtube.com/embed/-cjZOsU6PBg" title="YouTube video player" frameborder="0" allow="accelerometer; autoplay; clipboard-write; encrypted-media; gyroscope; picture-in-picture; web-share" allowfullscreen></iframe>
15 +{{/html}}
12 12  
13 13  == Acknowledgements ==
14 14  
... ... @@ -33,11 +33,11 @@
33 33  
34 34  From the Jupyter Lab launcher, click on the **Xircuits File** icon, as in the screenshot below.
35 35  
36 -[[image:newxircs.png]]
40 +[[image:xircuits-file-icon.png||alt="newxircs.png"]]
37 37  
38 38  A new file with the .xircuits extension will be generated under your current working directory. This is where you can start building the workflow diagram interactively.
39 39  
40 -[[image:newfile.png]]
44 +[[image:xircuits-generated-file.png||alt="newfile.png"]]
41 41  
42 42  You will notice that 2 components are already placed inside the workflow: the __Start__ and the __Finish__ components. They cannot be modified or deleted, and they represent the starting and finishing point of the workflow.
43 43  
... ... @@ -45,11 +45,11 @@
45 45  
46 46  Open the components tray, from the left-side bar icon highlighted below.
47 47  
48 -[[image:tray.png]]
52 +[[image:xircuits-extension-icon.png||alt="tray.png"]]
49 49  
50 50  Now, you can browse through the components, select the one you wish to use, then drag and drop it into the workflow area.
51 51  
52 -[[image:components.png]]
56 +[[image:xircuits-component-browser.png||alt="components.png"]]
53 53  
54 54  === **Step 3. Configure the components** ===
55 55  
... ... @@ -59,7 +59,7 @@
59 59  
60 60  The parameters need to be linked to the inputs of the component by dragging and dropping a connection from the output port of a literal/component towards the corresponding input port of the other component (e.g. the gray connections in the screenshot below).
61 61  
62 -[[image:diagr.png]]
66 +[[image:configure-components.png||alt="diagr.png"]]
63 63  
64 64  === **Step 4. Make connections** ===
65 65  
... ... @@ -67,29 +67,53 @@
67 67  
68 68  First, link the __Start__ node to the first component of your workflow. Then make the connections between all your components. The last component should be linked to the __Finish__ node, to indicate the end of your workflow (e.g. the blue connections in the screenshot below). These connections will dictate the order of execution of the components in your workflow.
69 69  
70 -[[image:diagram.png]]
74 +[[image:components-connection.png||alt="diagram.png"]]
71 71  
72 72  === **Step 5. Run the workflow** ===
73 73  
74 -After connecting everything, you need to run the workflow to actually see its result. For this you can click on the Run button (▶), which will also implicitly compile the workflow.
78 +After connecting everything, you need to run the workflow to actually see its results.
75 75  
76 -[[image:run.png]]
80 +There are 2 ways to run the workflow in EBRAINS Lab:
77 77  
82 +~1. Locally:
83 +
84 +* For this you can click on the Run button (▶), which will also implicitly compile the workflow. Make sure that __Local Run__ is selected near the Run button.
85 +
86 +[[image:local-run-button.png||alt="run.png"]]
87 +
88 +
89 +2. Remotely on HPC (only if you have access to HPC resources)
90 +
91 +* First choose the __Remote Run__ in the select box and then click the Run button (▶), which will also implicitly compile the workflow.
92 +
93 +[[image:remote-run-button.png||alt="remote.png"]]
94 +
95 +* A dialog will open to request the HPC connection details:
96 +** which __HPC Site__ to use
97 +** the name of the __HPC Project/Account__ you have access to
98 +** one checkbox to choose whether you want the __HPC Monitoring__ to be opened up automatically (via tvb-ext-unicore GUI). This can also be opened up manually using the __Monitor HPC__ button or the __U__ icon from the left side-bar.
99 +** one checkbox to choose whether you want the results to be __staged out__ automatically or not. If checked, the workflow waits for the HPC jobs to finish and then performs the stage out. If unchecked, the results can be manually downloaded later on by using the GUI of the tvb-ext-unicore.
100 +
101 +[[image:remote-run-configuration.png||alt="rem.png"]]
102 +
103 +* The HPC monitoring is done via the GUI of tvb-ext-unicore which is a separate package we have documented under this Wiki. But it can be nicely used together with tvb-ext-xircuits:
104 +
105 +[[image:hpc-monitoring.png||alt="uni.png"]]
106 +
107 +
78 78  After clicking on Run, a new Jupyter Output window should appear in the bottom of your Jupyter Lab environment. Here you will see the output of your workflow, such as logs, static plots, etc.
79 79  
80 -[[image:out.png]]
110 +[[image:jupyter-output-window.png||alt="out.png"]]
81 81  
82 82  === **Step 6. Share your work*** ===
83 83  
84 84  This step is, of course, optional, but it is worth mentioning that sharing your workflows with others is extremely easy. By just saving and sharing your workflow (*.xircuits) file, anyone can access the entire workflow, see the exact connections that you made and receive the same configuration for the components.
85 85  
86 -
87 -
88 88  == Custom functionalities ==
89 89  
90 90  As mentioned before, besides all the core functionalities provided by Xircuits, some other functionalities were added to better suit the needs of the EBRAINS users.
91 91  
92 -=== 1. Configure TVB models using the Phase Plane widget. ===
120 +=== 1. Configure TVB models using the Phase Plane widget ===
93 93  
94 94  This functionality was added to make it easier for users to provide the correct parameters to TVB models, using the Phase Plane widget.
95 95  
... ... @@ -96,21 +96,34 @@
96 96  To use this functionality, drag any model from the **TVB_MODELS** (inside the components tray) into the workflow area. Then right click on the model and select the **Open Viewer** option:
97 97  
98 98  
99 -(% style="text-align:center" %)
100 -[[image:image-20221116125354-2.png||height="800" width="1130"]]
127 +[[image:open-viewer-on-models.png||alt="image-20221116125354-2.png" data-xwiki-image-style-alignment="center" height="800" width="1130"]]
101 101  
102 102  
103 103  A new Jupyter tab should open, which contains a read-only Jupyter notebook. After following the instructions provided there, you should be able to see the Phase Plane widget associated with this particular model.
104 104  
105 -(% style="text-align:center" %)
106 -[[image:image-20221116125822-1.png||height="800" width="821"]]
132 +[[image:image-20221116125822-1.png||data-xwiki-image-style-alignment="center" height="800" width="821"]]
107 107  
108 108  After configuring the parameters with the desired values, go to the Exports tab of the widget and click on **Export model configuration**. Now all you have to do is to go back to the tab where your workflow is and you will see that the model will have values set for all the parameters that you modified in the Phase Plane widget (that is all the parameters there were assigned values different than the default ones).
109 109  
110 -(% style="text-align:center" %)
111 -[[image:image-20221116130425-1.png||height="900" width="1069"]]
136 +[[image:export-model-configuration.png||alt="image-20221116130425-1.png" data-xwiki-image-style-alignment="center" height="900" width="1069"]]
112 112  
113 113  
139 +=== 2. Visualize time series resulted from simulations ===
140 +
141 +This functionality is available for the **StoreResultsToDrive** component. Right click on the **StoreResultsToDrive** and select the **Open Viewer** option:
142 +
143 +[[image:open-viewer-button.png||alt="view.png"]]
144 +
145 +A new Jupyter tab should open, which contains a read-only Jupyter notebook. After running the cell, you should be able to see the **TimeSeriesBrowser **widget with the //**Collab**// and //**folder**// you have chosen for the **StoreResultsToDrive **component already loaded.
146 +
147 +[[image:view2.png]]
148 +
149 +Next, you should choose which time series file to display and click the **View time series button**.
150 +
151 +[[image:timeseries-plotly.png||alt="view3.png"]]
152 +
153 +== ==
154 +
114 114  == Workflow examples ==
115 115  
116 116  (((
... ... @@ -120,7 +120,7 @@
120 120  Contains all TVB components necessary for running a TVB simulation (i.e. connectivity, coupling, model, integrator, monitor, simulator).
121 121  
122 122  {{html}}
123 -<iframe src="https://drive.google.com/file/d/14sVjWXmtfZB-Zt7i3MA26-MiNWwv3jZI/preview" width="1280" height="720" allow="autoplay"></iframe>
164 +<iframe width="1280" height="720" src="https://www.youtube.com/embed/bmqPlIJsWLk" title="YouTube video player" frameborder="0" allow="accelerometer; autoplay; clipboard-write; encrypted-media; gyroscope; picture-in-picture; web-share" allowfullscreen></iframe>
124 124  {{/html}}
125 125  
126 126  
... ... @@ -129,7 +129,7 @@
129 129  Same workflow as before, but the parameter for the model used in simulation are set using the PhasePlaneWidget.
130 130  
131 131  {{html}}
132 -<iframe src="https://drive.google.com/file/d/1Puoi4-Ej4BhVwtdRzciPD_qNKMF0HvGT/preview" width="1280" height="720" allow="autoplay"></iframe>
173 +<iframe width="1280" height="720" src="https://www.youtube.com/embed/jhGfYul1z9k" title="YouTube video player" frameborder="0" allow="accelerometer; autoplay; clipboard-write; encrypted-media; gyroscope; picture-in-picture; web-share" allowfullscreen></iframe>
133 133  {{/html}}
134 134  
135 135  
... ... @@ -138,13 +138,13 @@
138 138  A simulation workflow where **siibra **is used to retrieve a connectivity from the EBRAINS KG. That connectivity is fed into a TVB Simulator, where the rest of the parameters (coupling, model, etc.) are set to default values.
139 139  
140 140  {{html}}
141 -<iframe src="https://drive.google.com/file/d/1bakH6ZD96eMHnYSw1aasF_gNXt8sBS7D/preview" width="1280" height="720" allow="autoplay"></iframe>
182 +<iframe width="1280" height="720" src="https://www.youtube.com/embed/hnqTpFGCYMg" title="YouTube video player" frameborder="0" allow="accelerometer; autoplay; clipboard-write; encrypted-media; gyroscope; picture-in-picture; web-share" allowfullscreen></iframe>
142 142  {{/html}}
143 143  
144 144  
145 -=== 4. Run a workflow inside an HPB job ===
186 +=== 4. Run a workflow as an HPB job ===
146 146  
147 147  A workflow simulation which is run remotely, by submitting a job to an HPC site and getting back the results (TimeSeries object).
148 148  
149 -{{html}}<iframe src="https://drive.google.com/file/d/1rvcj_9lGtR069iXlL3Rm1czMNdA3qmGM/preview" width="1280" height="720" allow="autoplay"></iframe>{{/html}}
190 +{{html}}<iframe width="1280" height="720" src="https://www.youtube.com/embed/M6rZClFgRrM" title="YouTube video player" frameborder="0" allow="accelerometer; autoplay; clipboard-write; encrypted-media; gyroscope; picture-in-picture; web-share" allowfullscreen></iframe>{{/html}}
150 150  
components-connection.png
Author
... ... @@ -1,0 +1,1 @@
1 +XWiki.teodoramisan
Size
... ... @@ -1,0 +1,1 @@
1 +261.7 KB
Content
configure-components.png
Author
... ... @@ -1,0 +1,1 @@
1 +XWiki.teodoramisan
Size
... ... @@ -1,0 +1,1 @@
1 +260.5 KB
Content
export-model-configuration.png
Author
... ... @@ -1,0 +1,1 @@
1 +XWiki.teodoramisan
Size
... ... @@ -1,0 +1,1 @@
1 +223.1 KB
Content
hpc-monitoring.png
Author
... ... @@ -1,0 +1,1 @@
1 +XWiki.teodoramisan
Size
... ... @@ -1,0 +1,1 @@
1 +220.1 KB
Content
jupyter-output-window.png
Author
... ... @@ -1,0 +1,1 @@
1 +XWiki.teodoramisan
Size
... ... @@ -1,0 +1,1 @@
1 +270.1 KB
Content
local-run-button.png
Author
... ... @@ -1,0 +1,1 @@
1 +XWiki.teodoramisan
Size
... ... @@ -1,0 +1,1 @@
1 +262.3 KB
Content
open-viewer-button.png
Author
... ... @@ -1,0 +1,1 @@
1 +XWiki.teodoramisan
Size
... ... @@ -1,0 +1,1 @@
1 +248.9 KB
Content
open-viewer-on-models.png
Author
... ... @@ -1,0 +1,1 @@
1 +XWiki.teodoramisan
Size
... ... @@ -1,0 +1,1 @@
1 +191.4 KB
Content
rem.png
Author
... ... @@ -1,0 +1,1 @@
1 +XWiki.paulapopa
Size
... ... @@ -1,0 +1,1 @@
1 +588.9 KB
Content
remote-run-button.png
Author
... ... @@ -1,0 +1,1 @@
1 +XWiki.teodoramisan
Size
... ... @@ -1,0 +1,1 @@
1 +215.3 KB
Content
remote-run-configuration.png
Author
... ... @@ -1,0 +1,1 @@
1 +XWiki.teodoramisan
Size
... ... @@ -1,0 +1,1 @@
1 +229.1 KB
Content
remote.png
Author
... ... @@ -1,0 +1,1 @@
1 +XWiki.paulapopa
Size
... ... @@ -1,0 +1,1 @@
1 +456.4 KB
Content
timeseries-plotly.png
Author
... ... @@ -1,0 +1,1 @@
1 +XWiki.teodoramisan
Size
... ... @@ -1,0 +1,1 @@
1 +318.7 KB
Content
uni.png
Author
... ... @@ -1,0 +1,1 @@
1 +XWiki.paulapopa
Size
... ... @@ -1,0 +1,1 @@
1 +608.5 KB
Content
view.png
Author
... ... @@ -1,0 +1,1 @@
1 +XWiki.paulapopa
Size
... ... @@ -1,0 +1,1 @@
1 +624.7 KB
Content
view2.png
Author
... ... @@ -1,0 +1,1 @@
1 +XWiki.paulapopa
Size
... ... @@ -1,0 +1,1 @@
1 +736.7 KB
Content
view3.png
Author
... ... @@ -1,0 +1,1 @@
1 +XWiki.paulapopa
Size
... ... @@ -1,0 +1,1 @@
1 +761.1 KB
Content
xircuits-component-browser.png
Author
... ... @@ -1,0 +1,1 @@
1 +XWiki.teodoramisan
Size
... ... @@ -1,0 +1,1 @@
1 +133.8 KB
Content
xircuits-extension-icon.png
Author
... ... @@ -1,0 +1,1 @@
1 +XWiki.teodoramisan
Size
... ... @@ -1,0 +1,1 @@
1 +106.9 KB
Content
xircuits-file-icon.png
Author
... ... @@ -1,0 +1,1 @@
1 +XWiki.teodoramisan
Size
... ... @@ -1,0 +1,1 @@
1 +122.8 KB
Content
xircuits-generated-file.png
Author
... ... @@ -1,0 +1,1 @@
1 +XWiki.teodoramisan
Size
... ... @@ -1,0 +1,1 @@
1 +106.4 KB
Content
Public

TVB Widgets