Wiki source code of Co-Simulation The Virtual Brain Multiscale

Version 36.3 by vbragin on 2024/03/02 12:30

version	line-number	content
1.1	1	(% class="jumbotron" %)
	2	(((
	3	(% class="container" %)
	4	(((
23.1	5	= (% style="color:inherit" %)TVB Co-Simulation {{html}}<iframe width="302" height="170" src="https://www.youtube.com/embed/6hEuvxD7IDk?list=PLVtblERyzDeLcVv4BbW3BvmO8D-qVZxKf" frameborder="0" allow="accelerometer; autoplay; encrypted-media; gyroscope; picture-in-picture" allowfullscreen></iframe>{{/html}} (%%) =
1.1	6
23.1	7
30.1	8	(% style="color:inherit" %)Multiscale: TVB, NEST, (%%)ANNarchy, NetPyNE , Elephant, PySpike
11.1	9
28.1	10	(% style="color:inherit" %)Authors: (%%)D. Perdikis, A. Blickensdörfer, V. Bragin, L. Domide, J. Mersmann, M. Schirner, P. Ritter(% style="color:inherit" %)
1.1	11	)))
	12	)))
	13
	14	(% class="row" %)
	15	(((
	16	(% class="col-xs-12 col-sm-8" %)
	17	(((
19.1	18	For more details on TVB see:
8.1	19
19.1	20	* TVB Dedicated Wiki [[https:~~/~~/wiki.ebrains.eu/bin/view/Collabs/the-virtual-brain/>>url:https://wiki.ebrains.eu/bin/view/Collabs/the-virtual-brain/]]
	21	* TVB in HBP User Story [[https:~~/~~/wiki.ebrains.eu/bin/view/Collabs/user-story-tvb/>>url:https://wiki.ebrains.eu/bin/view/Collabs/user-story-tvb/]]
	22
31.1	23	== ==
1.1	24
31.1	25	== Running TVB-MULTISCALE at EBRAINS JupyterLab ==
	26
32.1	27	TVB-multiscale is made available at [[EBRAINS JupyterLab>>https://lab.ebrains.eu/]].
31.1	28
36.2	29	All the user has to do is log in with their EBRAINS credentials, and start a Python console or a Jupyter notebook using the kernel "EBRAINS-23.09" (or a more recent version), where TVB-multiscale can be imported (e.g., via "import tvb_multiscale"). All necessary TVB-multiscale dependencies (NEST, ANNarchy, NetPyNE (NEURON), Elephant, Pyspike) are also installed and available.
31.1	30
36.2	31	This collab contains various examples of using TVB-Multiscale with all three supported spiking simulators. We suggest copying the contents of this collab to your Library or to any collab owned by you, and running them there (note that the user's drive offers persistent storage, i.e. users will find their files after logging out and in again), as follows:
32.1	32
36.2	33	~1. Select `Drive` on the left of the current page (or use [[this link>>https://wiki.ebrains.eu/bin/view/Collabs/the-virtual-brain-multiscale/Drive]]).
32.1	34
36.2	35	2. Check the `tvb-multiscale-collab` folder checkbox, and copy it to your `My Library` ("copy" icon will appear above the files/folders list).
32.1	36
36.2	37	3. Select `Lab` (on the left), and navigate to the destination where you just copied the folder.
32.1	38
36.2	39	4. Enter the `tvb-multiscale-collab` folder, and open either of example notebooks. Ensure you select the appropriate ipykernel (EBRAINS-23.09 or a more recent one)
32.1	40
	41
31.1	42	== Use our Jupyter Hub setup online ((% style="color:#c0392b" %)DEPRECATED(%%)) ==
	43
	44	(% style="color:#c0392b" %)TVB-multiscale app is deprecated and will stop being available after the end of 2023!
	45
29.1	46	We have setup a Jupyter Hub service with tvb-multiscale as backed already prepared. You will only need an HBP account for accessing this: [[https:~~/~~/tvb-multiscale.apps.hbp.eu/>>https://tvb-multiscale.apps.hbp.eu/]]
7.2	47
28.1	48	This JupyterHub installation works smoothly with HBP Collab user credentials (login only once at HBP and get access here too). We use a custom Docker Hub tvb-multiscale image as a backend, and thus a ready to use environment is available immediately, without the need of any local installation or download. This should be the ideal env for demos, presentations or even workshops with tvb-multiscale.
7.2	49
	50	[[image:https://lh6.googleusercontent.com/ytx9eYpMcL3cCScX2_Sxm4CeBW0xbKW3xKsfO2zSId10bW0gw1kiN2_SkexyYBCsF-sKsu0MaJC4cZvGVfQPjMoPBLiePbkvXOZd8BgY3Q0kFzSkRCqQ183lgDQv_6PYoqS3s7uJ\|\|height="149" width="614"]]
	51
28.1	52	Currently, the users can access 2 folders: //TVB-*-Examples// and //Contributed-Notebooks//.
7.2	53
28.1	54	The notebooks under *TVB--Examples** are public, shared by everyone accessing the instance. Periodically, we will clean all changes under TVB-*-Examples folder (by redeploying the pod image), and show the original example notebooks submitted on our Github repo. If users intend to contribute here, they are encouraged to submit changes through Pull Requests ([[https:~~/~~/github.com/the-virtual-brain/tvb-multiscale>>url:https://github.com/the-virtual-brain/tvb-multiscale]])
7.2	55
	56	[[image:https://lh6.googleusercontent.com/nnsM0mhXQinmQsJwZwwwe5Sx7f-tZc8t4ELnCh9DwksyVEPUE-jixJTkhoP4l25VKwlDGoXACWtnuxQM9NMOCYbQOzDesgMDlT3sntow___vsEqRVd4OwqMY4BPyBiLJ32BnUbmM\|\|height="267" width="614"]]
	57
31.1	58	Folder Contributed-Notebooks is not shared. Here, users can experiment with their own private examples. This folder is persisted on restarts in the user HBP Collab personal space. Thus, users will be able to access their work even after a redeploy. (e.g. during a workshop every participant could have in here his own exercise solution)
7.2	59
31.1	60
28.1	61	== Running TVB-MULTISCALE locally ==
7.2	62
31.1	63	See more on Github [[https:~~/~~/github.com/the-virtual-brain/tvb-multiscale>>url:https://github.com/the-virtual-brain/tvb-multiscale]] .
7.2	64
31.1	65	Documented notebooks and other examples will be ok to download and try yourself locally, after you have also prepared and launched locally a Docker env: [[https:~~/~~/hub.docker.com/r/thevirtualbrain/tvb-multiscale>>https://hub.docker.com/r/thevirtualbrain/tvb-multiscale]]
7.2	66
28.1	67	This is the path recommended for people working closely with tvb-multiscale. They are able to download it in their local work env and code freely and fast with it.
7.2	68
31.1	69	== ==
	70
28.1	71	== Running TVB-MULTISCALE jobs on CSCS infrastructure from HBP collab ==
7.2	72
28.1	73	The CSCS and HBP Collab deployment of tvb-multiscale is a good example to show how tvb-multiscale can run with an HPC backend. This will be efficient when the simulation jobs are very large. From our experience, with small jobs, the stage-in/out time is considerable, and then the user might be better with just a local run. Also, this deployment requires that the user have an active CSCS personal account. More details on how to use this deployment can be found in this movie: [[https:~~/~~/drive.google.com/open?id=1osF263FK_NjhZcBJfpSy-F7qkbYs3Q-E>>url:https://drive.google.com/open?id=1osF263FK_NjhZcBJfpSy-F7qkbYs3Q-E]]
7.2	74
	75	* Create a collab space of your own
	76	* Clone and run in your HBP Collab Hub ([[https:~~/~~/lab.ebrains.eu/>>url:https://lab.ebrains.eu/]]) the notebooks from here: [[https:~~/~~/drive.ebrains.eu/d/245e6c13082f45bcacfa/>>url:https://drive.ebrains.eu/d/245e6c13082f45bcacfa/]]
	77	** test_tvb-nest_installation.ipynb Run the cosimulate_tvb_nest.sh script on the CSCS Daint supercomputer. In this example, basically we are running the //installation_test.py// file which is in the docker folder.
28.1	78	** run_custom_cosimulation.ipynb For this example we are using the //cosimulate_with_staging.sh// script in order to pull the tvb-multiscale docker image and we are using a custom simulation script (from Github page) which will be uploaded in the staging in phase
7.2	79	** run_custom_cosimulation_from_notebook.ipynb This example is running the same simulation as the example above but instead of using an external file with the simulation code we will build a simulation file from a few notebook cells and we will pass this file to the CSCS server.
	80
	81	Few technical details about what we do in these notebooks:
	82
	83	1. Prepare UNICORE client api.
	84
	85	PYUNICORE client library is available on PYPI. In order to use it you have to install it using:
	86
	87	>pip install pyunicore
	88
	89	Next step is to configure client registry and what supercomputer to use
	90
	91	>tr = unicore_client.Transport(oauth.get_token())
	92	>r = unicore_client.Registry(tr, unicore_client._HBP_REGISTRY_URL)
	93	># use "DAINT-CSCS" change if another supercomputer is prepared for usage
	94	>client = r.site('DAINT-CSCS')
	95
	96	1. Prepare job submission
	97
	98	In this step we have to prepare a JSON object which will be used in the job submission process.
	99
	100	># What job will execute (command/executable)
	101	>my_job['Executable'] = 'job.sh'
	102	>
	103	># To import files from remote sites to the job’s working directory
	104	>my_job['Imports'] = [{
	105	> "From": "https:~/~/raw.githubusercontent.com/the-virtual-brain/tvb-multiscale/update-collab-examples/docker/cosimulate_tvb_nest.sh",
	106	> "To" : job.sh
	107	>}]
	108	>
	109	># Specify the resources to request on the remote system
	110	>my_job['Resources'] = {
	111	> "CPUs": "1"}
	112
	113	1. Actual job submission
	114
	115	In order to submit a job we have to use the JSON built in the previous step and also if we have some local files, we have to give their paths as a list of strings (inputs argument) so the UNICORE library will upload them in the job's working directory in the staging in phase, before launching the job.
	116
	117	>job = site_client.new_job(job_description=my_job, inputs=['/path1', '/path2'])
	118	>job.properties
	119
	120	1. Wait until job is completed and check the results
	121
	122	Wait until the job is completed using the following command
	123
	124	># TRUE or FALSE
	125	>job.is_running()
	126
	127	Check job's working directory for the output files/directories using
	128
	129	>wd = job.working_dir
	130	>wd.listdir()
	131
	132	From working job you can preview files content and download files
	133
	134	># Read 'stdout' file
	135	>out = wd.stat("stdout")
	136	>f = out.raw()
	137	>all_lines = f.read().splitlines()
	138	>all_lines[-20:]
	139	>
	140	># Download 'outputs/res/results.npy' file
	141	>wd.stat("outputs/res/results.npy").download("results.npy")
1.1	142	)))
	143
	144
	145	(% class="col-xs-12 col-sm-4" %)
	146	(((
	147	{{box title="Contents"}}
	148	{{toc/}}
	149	{{/box}}
	150
	151
	152	)))
	153	)))