Attention: The EBRAINS Wiki will be down Tuesday 14th October, from 18:00 CEST (my timezone) for up to 30 minutes due to an upgrade. 


Wiki source code of QuickTry

Last modified by kindler on 2025/09/10 15:51
Hide last authors
kindler 2.1 1 == "Quick Start" options ==
kindler 1.1 2
3 For a "quick start" without wait time for us to create a Collab for you we have these options:
4
kindler 16.1 5 === A //non-persistent// "quick first look" ===
kindler 1.1 6
7 This method is **non-persistent **= whatever you change in the example notebooks **~*~*will be lost~*~*** when the session expires.
8
kindler 16.1 9 It is useful for a get-an-impression-fast:
kindler 1.1 10
kindler 16.1 11 * For BrainScaleS: [[Access this URL>>https://lab.jsc.ebrains.eu/hub/user-redirect/git-pull?repo=https%3A%2F%2Fgithub.com%2Felectronicvisions%2Fbrainscales2-demos.git&urlpath=lab%2Ftree%2Fbrainscales2-demos.git%2Ftutorial.ipynb&branch=jupyter-notebooks-experimental]] 
12 This automatically clones the BrainScaleS example notebooks ([[from github>>https://github.com/electronicvisions/brainscales2-demos.git]]) into a lab session into a //non-persistent// location and opens the **tutorial index notebook**.
kindler 1.1 13 You can also directly jump to e.g. the [[single neuron notebook>>https://lab.jsc.ebrains.eu/hub/user-redirect/git-pull?repo=https%3A%2F%2Fgithub.com%2Felectronicvisions%2Fbrainscales2-demos.git&urlpath=lab%2Ftree%2Fbrainscales2-demos.git%2Fts_00-single_neuron.ipynb&branch=jupyter-notebooks-experimental]] or the [[learning with superspike notebook>>https://lab.jsc.ebrains.eu/hub/user-redirect/git-pull?repo=https%3A%2F%2Fgithub.com%2Felectronicvisions%2Fbrainscales2-demos.git&urlpath=lab%2Ftree%2Fbrainscales2-demos.git%2Fts_01-superspike.ipynb&branch=jupyter-notebooks-experimental]].
kindler 3.1 14 To run the notebook cells use the "Run" menu item. To execute all cells of the notebook use the "Run > Run all" menu item in the Jupyter window.
kindler 16.1 15
16 * For SpiNNaker: [[Access this URL>>https://lab.jsc.ebrains.eu/hub/user-redirect/git-pull?repo=https%3A%2F%2Fgithub.com%2FSpiNNakerManchester%2FSpiNNakerJupyterExamples.git&urlpath=lab%2Ftree%2FSpiNNakerJupyterExamples.git%2FSpiNNaker_Collab_synfire.ipynb&branch=main]]
17 This automatically clones an example notebook for running a "synfire chain" on SpiNNaker ([[from github>>https://github.com/SpiNNakerManchester]]) into a lab session into a //non-persistent// location and opens it.
18 To run the notebook cells use the "Run" menu item. To execute all cells of the notebook use the "Run > Run all" menu item in the Jupyter window.
kindler 1.1 19
kindler 16.1 20 Notes:
kindler 15.1 21
kindler 16.1 22 * if a fresh "lab session" is started for your user you will be asked, which container should be started. Please select the one marked "recommended".
23 * a "lab session" will be automatically terminated after some hours of inactivity. At that event the notebooks cloned via the access URL above will be deleted = any changes you entered will be lost = great for a quick "first look", but not so great for longer term research ... 
24 To be able to keep changes, please use the method described below (with an own "Collab")
kindler 15.1 25
kindler 1.1 26 === Getting the example notebooks into an own Collab ===
27
28 This method allows you to also change the example notebooks and **keep the changes**
29
30 1. create a new Collab for yourself:
31 11. go to [[https:~~/~~/wiki.ebrains.eu/>>https://wiki.ebrains.eu/]] and click the "Log-in" link in the upper right hand corner, log in with your new EBRAINS account
32 11. Click the "Collabs" link in the menu bar at the top of the window
kindler 16.1 33 11. Click the "Create a collab" green button and create a private Collab for yourself. The process re-directs you into your own, new Collab.  
34
kindler 1.1 35 1. In your new Collab open the Lab and clone the files you want to work with:
36 11. Click the "Lab" link in the left hand menu
37 [[image:1752049786563-126.png]]
kindler 16.1 38 11. Select any of the "Lab Execution Site" offered, (e.g. Jülich)
39 [[image:1752049824848-523.png]]
kindler 1.1 40 then select the "Official EBRAINS Docker image", click start. (Click "Launch Server", if you get a "Server not running" page)
41 This will start a Jupyter Lab session (the "Lab") for you. 
42
43 11. Start a "Terminal" via the icon in the "Launcher window" shown. This opens a terminal in the "/mnt/user/shared/NAME_OF_YOUR_COLLAB/" directory. This is a location on the EBRAINS "Drive". Files stored in this location are stored persistently = will still be there, when you open your Collab again some days later 
44 Note: If you use "File" > "New" > "Terminal" the opened terminal is in the directory "/opt/app-root/src". This location only exists while the Jupyter ("Lab") session is running and will be gone, when a new Lab session is started. Do not use this location, if you want to keep the files. To change into the persistent directory type "cd /mnt/user/shared/NAME_OF_YOUR_COLLAB" (without the " and the name of your your Collab instead of NAME_OF_YOUR_COLLAB. The collab name in the screenshot is "20250709-testCollab")
45 [[image:1752049957171-549.png]]
46
47 11. then fetch the files you would like to work with.
48 \\For the **BrainScaleS-2 interactive notebooks** use the command in the terminal window: 
49 //git clone https:~/~/github.com/electronicvisions/brainscales2-demos.git ~-~-branch jupyter-notebooks-experimental//
50 [[image:1752049987784-838.png]]
51 \\The command clones the BrainScaleS interactive notebooks into a directory "brainscales2-demos". This directory appears then in the files list on the left hand side of the window. Double click it to enter the freshly cloned directory with tutorial notebooks.
52 To see an overview, open the "tutorial.ipynb"
53 [[image:1752050031198-600.png]]
54 Run the notebooks of your choice...
55 \\\\For **SpiNNaker** example notebooks use the command in the terminal window:
56 git clone [[https:~~/~~/github.com/SpiNNakerManchester/SpiNNakerJupyterExamples.git>>https://github.com/SpiNNakerManchester/SpiNNakerJupyterExamples.git]]
57 This creates the SpiNNakerJupyterExamples directory.
58 First run the "Setup" notebook in the directory (choose the "EBRAINS-...." kernel, when asked), select "Run" > "Run all cells" 
59 Then your environment is prepared to run the examples (e.g. the 01.RuningPyNNSimulations").
60 Note: As Kernel (right hand corner of the title line of the notebook), please use the "EBRAINS-...." kernel, not the default iPython Kernel. Some modules will not be found with the default kernel.