Hide last authors
| author | version | line-number | content |
|---|---|---|---|
 |
2.1 | 1 | == "Quick Start" options == |
| |
1.1 | 2 | |
| 3 | For a "quick start" without wait time for us to create a Collab for you we have these options: | ||
| 4 | |||
| 5 | === A non-persistent "quick first look" === | ||
| 6 | |||
| 7 | This method is **non-persistent **= whatever you change in the example notebooks **~*~*will be lost~*~*** when the session expires. | ||
| 8 | |||
| 9 | It is useful for a get-an-impression-fast: | ||
| 10 | |||
| 11 | 1. [[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]]: this will starts a lab session - you will be asked, which container to start. Please choose the one marked "recommended". | ||
| 12 | 1. Access the same URL again (if a lab session was already running for your user you only need to access the URL once) | ||
| 13 | This then automatically clones the BrainScaleS example notebooks ([[from github>>https://github.com/electronicvisions/brainscales2-demos.git]]) into the now running lab session into a non-persistent location and opens the **tutorial index notebook**. | ||
| 14 | 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]]. | ||
| 15 | To run the notebook cells use the "Run" menu item. | ||
| 16 | \\ | ||
| 17 | |||
| 18 | === Getting the example notebooks into an own Collab === | ||
| 19 | |||
| 20 | This method allows you to also change the example notebooks and **keep the changes** | ||
| 21 | |||
| 22 | 1. create a new Collab for yourself: | ||
| 23 | 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 | ||
| 24 | 11. Click the "Collabs" link in the menu bar at the top of the window | ||
| 25 | 11. Click the "Create a collab" green button and create a private Collab for yourself. The process re-directs you into the new Collab. | ||
| 26 | 1. In your new Collab open the Lab and clone the files you want to work with: | ||
| 27 | 11. Click the "Lab" link in the left hand menu | ||
| 28 | [[image:1752049786563-126.png]] | ||
| 29 | 11. Select any of the "Lab Execution Site" offered, [[image:1752049824848-523.png]] | ||
| 30 | then select the "Official EBRAINS Docker image", click start. (Click "Launch Server", if you get a "Server not running" page) | ||
| 31 | This will start a Jupyter Lab session (the "Lab") for you. | ||
| 32 | |||
| 33 | 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 | ||
| 34 | 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") | ||
| 35 | [[image:1752049957171-549.png]] | ||
| 36 | |||
| 37 | 11. then fetch the files you would like to work with. | ||
| 38 | \\For the **BrainScaleS-2 interactive notebooks** use the command in the terminal window: | ||
| 39 | //git clone https:~/~/github.com/electronicvisions/brainscales2-demos.git ~-~-branch jupyter-notebooks-experimental// | ||
| 40 | [[image:1752049987784-838.png]] | ||
| 41 | \\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. | ||
| 42 | To see an overview, open the "tutorial.ipynb" | ||
| 43 | [[image:1752050031198-600.png]] | ||
| 44 | Run the notebooks of your choice... | ||
| 45 | \\\\For **SpiNNaker** example notebooks use the command in the terminal window: | ||
| 46 | git clone [[https:~~/~~/github.com/SpiNNakerManchester/SpiNNakerJupyterExamples.git>>https://github.com/SpiNNakerManchester/SpiNNakerJupyterExamples.git]] | ||
| 47 | This creates the SpiNNakerJupyterExamples directory. | ||
| 48 | First run the "Setup" notebook in the directory (choose the "EBRAINS-...." kernel, when asked), select "Run" > "Run all cells" | ||
| 49 | Then your environment is prepared to run the examples (e.g. the 01.RuningPyNNSimulations"). | ||
| 50 | 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. |