# tvb-ext-xircuits
This is a jupyterlab extension built as a prototype for building EBRAINS
(including TVB simulator, Siibra API) workflows in a visual and interactive manner. It
extends the already existent [Xircuits](https://xircuits.io/) jupyterlab extension
by adding new components and new features on top.
For installing in a Jupyter Lab environment:
pip install tvb-ext-xircuits
For dev mode setup there are 2 alternatives:
1. Using `jlpm`:
`jlpm` is a JupyterLab-provided, locked version of `yarn` and has a similar usage:
```
conda activate [my-env]
pip install --upgrade pip
pip install -e .
jupyter labextension develop . --overwrite # Link your development version of the extension with JupyterLab
jupyter server extension enable tvbextxircuits # Enable the server extension
tvbextxircuits
```
2. Using `yarn`:
You need to have a dedicated `Python env`, `yarn`, `rust` and `cargo` (from https://rustup.rs/) prepared:
```
conda activate [my-env]
pip install --upgrade pip
pip install -e .
yarn install
yarn install:extension
tvbextxircuits
```
To rebuild the extension after making changes to it:
# Rebuild Typescript source after making changes
jlpm build
# Rebuild extension after making any changes
jupyter lab build
To rebuild automatically:
# Watch the source directory in another terminal tab
jlpm run watch
# Run Xircuits in watch mode in one terminal tab
jupyter lab --watch
## Notes
To be able to see details info related to TVB components you must first run the command `python generate_description_files.py`
Notebooks generated can be found at `TVB_generated_notebooks/<xircuits_id>`
## Acknowledgments
Copyright (c) 2022-2023 to Xircuits Team See: https://github.com/XpressAI/xircuits
Copyright (c) 2022-2023 to TVB-Xircuits team (SDL Neuroscience Juelich, INS Marseille, Codemart) for changes in this fork.
This extension is build on top of the Xircuits https://xircuits.io Jupyter extension, and it adds custom features, tailored for EBRAINS env.
This project has received funding from the European Union’s Horizon 2020 Framework Programme for Research and Innovation under the Specific Grant Agreement No. 945539 (Human Brain Project SGA3).
Raw data
{
"_id": null,
"home_page": "https://github.com/the-virtual-brain/tvb-ext-xircuits",
"name": "tvb-ext-xircuits",
"maintainer": "",
"docs_url": null,
"requires_python": ">=3.8",
"maintainer_email": "",
"keywords": "Jupyter,JupyterLab,JupyterLab3",
"author": "Xpress AI",
"author_email": "eduardo@xpress.ai",
"download_url": "https://files.pythonhosted.org/packages/71/de/038362d074c57e02ab7c402ac96e2fb89aabb116994ab5645f14e0616b01/tvb-ext-xircuits-1.1.0.tar.gz",
"platform": "Linux",
"description": "# tvb-ext-xircuits\n\nThis is a jupyterlab extension built as a prototype for building EBRAINS \n(including TVB simulator, Siibra API) workflows in a visual and interactive manner. It \nextends the already existent [Xircuits](https://xircuits.io/) jupyterlab extension \nby adding new components and new features on top.\n\nFor installing in a Jupyter Lab environment:\n\n pip install tvb-ext-xircuits\n\n\nFor dev mode setup there are 2 alternatives:\n1. Using `jlpm`:\n\n `jlpm` is a JupyterLab-provided, locked version of `yarn` and has a similar usage:\n\n ```\n conda activate [my-env]\n pip install --upgrade pip\n pip install -e .\n jupyter labextension develop . --overwrite # Link your development version of the extension with JupyterLab\n jupyter server extension enable tvbextxircuits # Enable the server extension\n tvbextxircuits\n ```\n\n2. Using `yarn`:\n\n You need to have a dedicated `Python env`, `yarn`, `rust` and `cargo` (from https://rustup.rs/) prepared:\n \n ```\n conda activate [my-env]\n pip install --upgrade pip\n pip install -e .\n yarn install\n yarn install:extension\n tvbextxircuits\n ```\n \nTo rebuild the extension after making changes to it:\n\n # Rebuild Typescript source after making changes\n jlpm build\n # Rebuild extension after making any changes\n jupyter lab build\n\nTo rebuild automatically:\n\n # Watch the source directory in another terminal tab\n jlpm run watch\n # Run Xircuits in watch mode in one terminal tab\n jupyter lab --watch\n\n## Notes\nTo be able to see details info related to TVB components you must first run the command `python generate_description_files.py`\n\nNotebooks generated can be found at `TVB_generated_notebooks/<xircuits_id>`\n\n## Acknowledgments\n\nCopyright (c) 2022-2023 to Xircuits Team See: https://github.com/XpressAI/xircuits\n\nCopyright (c) 2022-2023 to TVB-Xircuits team (SDL Neuroscience Juelich, INS Marseille, Codemart) for changes in this fork.\n\nThis extension is build on top of the Xircuits https://xircuits.io Jupyter extension, and it adds custom features, tailored for EBRAINS env.\n\nThis project has received funding from the European Union\u2019s Horizon 2020 Framework Programme for Research and Innovation under the Specific Grant Agreement No. 945539 (Human Brain Project SGA3).\n",
"bugtrack_url": null,
"license": "Apache-2.0",
"summary": "Jupyterlab extension for building TVB workflows in a visual and interactive manner",
"version": "1.1.0",
"project_urls": {
"Homepage": "https://github.com/the-virtual-brain/tvb-ext-xircuits"
},
"split_keywords": [
"jupyter",
"jupyterlab",
"jupyterlab3"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "5112509f8979a7280c1cd31884a044ec871b089c2ca00e686ca3fa746912db15",
"md5": "8a033d4415b4bd82a890cd38f1ecec12",
"sha256": "d34949358f8677c71082987276eb0724780cbdcf4fcbdb1926d6429f7b199e6c"
},
"downloads": -1,
"filename": "tvb_ext_xircuits-1.1.0-py3-none-any.whl",
"has_sig": false,
"md5_digest": "8a033d4415b4bd82a890cd38f1ecec12",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.8",
"size": 2405453,
"upload_time": "2023-08-08T13:50:37",
"upload_time_iso_8601": "2023-08-08T13:50:37.048813Z",
"url": "https://files.pythonhosted.org/packages/51/12/509f8979a7280c1cd31884a044ec871b089c2ca00e686ca3fa746912db15/tvb_ext_xircuits-1.1.0-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "71de038362d074c57e02ab7c402ac96e2fb89aabb116994ab5645f14e0616b01",
"md5": "c5f7b4d139854ece500cefd4e2899db9",
"sha256": "37c71be6ac8e4abb91501b2eb788167f6142eefd2f36ef061d760d2e61828afd"
},
"downloads": -1,
"filename": "tvb-ext-xircuits-1.1.0.tar.gz",
"has_sig": false,
"md5_digest": "c5f7b4d139854ece500cefd4e2899db9",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.8",
"size": 1954938,
"upload_time": "2023-08-08T13:50:39",
"upload_time_iso_8601": "2023-08-08T13:50:39.575463Z",
"url": "https://files.pythonhosted.org/packages/71/de/038362d074c57e02ab7c402ac96e2fb89aabb116994ab5645f14e0616b01/tvb-ext-xircuits-1.1.0.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2023-08-08 13:50:39",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "the-virtual-brain",
"github_project": "tvb-ext-xircuits",
"travis_ci": false,
"coveralls": false,
"github_actions": true,
"requirements": [],
"lcname": "tvb-ext-xircuits"
}
JSON
