Skip to main content

TVB logo VBT logo

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 jupyterlab extension by adding new components and new features on top.

Starting with version 2.0.0, tvb-ext-xircuits can be installed in lightweight mode or in full mode.

Full mode means that the extension will be fully working and able to run workflows.

Lightweight mode means that only the front-end part of the extension will be available, meaning that the users will be able to see all the extension's components, but running workflows will not work.

To install the extension locally and in full mode (recommended):

pip install tvb-ext-xircuits[full]

To install the extension in lightweight mode (only for specialized users):

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 .[full]
    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 .[full]
    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-2026 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.

Copyright (c) 2024-2026 to Codemart - Brainiacs team for further 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 and VBT environments.

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).

This project has received funding from the European Union’s Horizon Europe Programme under the Specific Grant Agreement No. 101147319 (EBRAINS 2.0 Project).

This project has received funding from the European Union’s Research and Innovation Program Horizon Europe under Grant Agreement No. 101137289 (Virtual Brain Twin Project).

Metadata

Release files for tvb-ext-xircuits 3.0.2

For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.

Source distribution (sdist)

Source distribution for tvb-ext-xircuits 3.0.2
File Size Uploaded Provenance Actions
tvb_ext_xircuits-3.0.2.tar.gz 3.2 MB Without provenance Details for tvb_ext_xircuits-3.0.2.tar.gz

Built distribution (wheel)

Table of built distributions (wheels) for tvb-ext-xircuits 3.0.2
File Interpreter ABI Platform Actions
tvb_ext_xircuits-3.0.2-py3-none-any.whl Python 3 none any Details for tvb_ext_xircuits-3.0.2-py3-none-any.whl

Total release size: 7.2 MB

Release files / tvb_ext_xircuits-3.0.2.tar.gz

Download URL tvb_ext_xircuits-3.0.2.tar.gz
Size 3.2 MB
Tags Source
SHA-256 checksum
How to use checksums
30a393dbb2fb4994cb6981f147838a11cc79a56ef43200df23bcc03fc0a45d45
BLAKE2b-256 checksum
How to use checksums
3ba210bf8f1165ebff0ac44b090f1bec584bf6de5ec726f6d0cbb355de3b0c10
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via twine/7.0.0 CPython/3.11.18

Release files / tvb_ext_xircuits-3.0.2-py3-none-any.whl

Download URL tvb_ext_xircuits-3.0.2-py3-none-any.whl
Size 4.0 MB
Tags Python 3
SHA-256 checksum
How to use checksums
56d0ade4a7150923158ce34b31a8c5c6d238e2e96e1fd70c2b67da1e63ffb2b1
BLAKE2b-256 checksum
How to use checksums
bcf69702c126820af345ea1f38511b9a33fb9ef0322400cb6ab767b68dd13a8a
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via twine/7.0.0 CPython/3.11.18

Security for tvb-ext-xircuits 3.0.2

Provenance

Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.

No provenance found

None of the files in this release were uploaded with provenance metadata.

A note on package security

PyPI is a repository for distributing packages, not a service for auditing them. While third-party security researchers and our staff do their best to detect and remove malicious packages, PyPI cannot guarantee the quality, security or suitability of any given package.

To learn more about protecting yourself from malicious actors, visit our package security documentation.

Anthropic, PBC Visionary sponsor Bloomberg Visionary sponsor Hudson River Trading Visionary sponsor Meta Visionary sponsor NVIDIA Visionary sponsor Microsoft Sustainability sponsor Depot Continuous Integration AWS Cloud computing and Security Sponsor Datadog Monitoring Fastly CDN Google Download Analytics Sentry Error logging StatusPage Status page