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 57.1
edited by paulapopa
on 2023/03/24 08:10
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
... ... @@ -37,11 +37,11 @@
37 37  
38 38  From the Jupyter Lab launcher, click on the **Xircuits File** icon, as in the screenshot below.
39 39  
40 -[[image:newxircs.png]]
40 +[[image:xircuits-file-icon.png||alt="newxircs.png"]]
41 41  
42 42  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.
43 43  
44 -[[image:newfile.png]]
44 +[[image:xircuits-generated-file.png||alt="newfile.png"]]
45 45  
46 46  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.
47 47  
... ... @@ -49,11 +49,11 @@
49 49  
50 50  Open the components tray, from the left-side bar icon highlighted below.
51 51  
52 -[[image:tray.png]]
52 +[[image:xircuits-extension-icon.png||alt="tray.png"]]
53 53  
54 54  Now, you can browse through the components, select the one you wish to use, then drag and drop it into the workflow area.
55 55  
56 -[[image:components.png]]
56 +[[image:xircuits-component-browser.png||alt="components.png"]]
57 57  
58 58  === **Step 3. Configure the components** ===
59 59  
... ... @@ -63,7 +63,7 @@
63 63  
64 64  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).
65 65  
66 -[[image:diagr.png]]
66 +[[image:configure-components.png||alt="diagr.png"]]
67 67  
68 68  === **Step 4. Make connections** ===
69 69  
... ... @@ -71,7 +71,7 @@
71 71  
72 72  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.
73 73  
74 -[[image:diagram.png]]
74 +[[image:components-connection.png||alt="diagram.png"]]
75 75  
76 76  === **Step 5. Run the workflow** ===
77 77  
... ... @@ -83,7 +83,7 @@
83 83  
84 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 85  
86 -[[image:run.png]]
86 +[[image:local-run-button.png||alt="run.png"]]
87 87  
88 88  
89 89  2. Remotely on HPC (only if you have access to HPC resources)
... ... @@ -90,7 +90,7 @@
90 90  
91 91  * First choose the __Remote Run__ in the select box and then click the Run button (▶), which will also implicitly compile the workflow.
92 92  
93 -[[image:remote.png]]
93 +[[image:remote-run-button.png||alt="remote.png"]]
94 94  
95 95  * A dialog will open to request the HPC connection details:
96 96  ** which __HPC Site__ to use
... ... @@ -98,22 +98,21 @@
98 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 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 100  
101 -[[image:rem.png]]
101 +[[image:remote-run-configuration.png||alt="rem.png"]]
102 102  
103 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 104  
105 -[[image:uni.png]]
105 +[[image:hpc-monitoring.png||alt="uni.png"]]
106 106  
107 107  
108 108  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.
109 109  
110 -[[image:out.png]]
110 +[[image:jupyter-output-window.png||alt="out.png"]]
111 111  
112 112  === **Step 6. Share your work*** ===
113 113  
114 114  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.
115 115  
116 -
117 117  == Custom functionalities ==
118 118  
119 119  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.
... ... @@ -125,34 +125,32 @@
125 125  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:
126 126  
127 127  
128 -(% style="text-align:center" %)
129 -[[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"]]
130 130  
131 131  
132 132  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.
133 133  
134 -(% style="text-align:center" %)
135 -[[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"]]
136 136  
137 137  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).
138 138  
139 -(% style="text-align:center" %)
140 -[[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"]]
141 141  
142 142  
143 143  === 2. Visualize time series resulted from simulations ===
144 144  
141 +This functionality is available for the **StoreResultsToDrive** component. Right click on the **StoreResultsToDrive** and select the **Open Viewer** option:
145 145  
146 -[[image:view.png]]
143 +[[image:open-viewer-button.png||alt="view.png"]]
147 147  
148 -=== ===
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.
149 149  
150 150  [[image:view2.png]]
151 151  
149 +Next, you should choose which time series file to display and click the **View time series button**.
152 152  
151 +[[image:timeseries-plotly.png||alt="view3.png"]]
153 153  
154 -[[image:view3.png]]
155 -
156 156  == ==
157 157  
158 158  == Workflow examples ==
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
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
timeseries-plotly.png
Author
... ... @@ -1,0 +1,1 @@
1 +XWiki.teodoramisan
Size
... ... @@ -1,0 +1,1 @@
1 +318.7 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