Skip to main content
Pre-release

This release is a pre-release and may not be stable for production use.

TVB FRAMEWORK

The Virtual Brain framework is a complete framework including:

  • a plugable workflow manager;

  • a data persistence layer (with a relational DB and File Storage);

  • an HTML5 based user interface;

  • visualizers for neuro-science related entities.

The easiest way to make use of this code, is to obtain a Distribution of TVB with Python and all the necessary packages linked, and then clone this repo nearby. More details in our documentation.

Alternatively, if you plan to develop long term with TVB, extensively modify code, add new dependencies, or you simply prefer to use your own Python installation, you may want to read this: here.

If you don’t require the framework features listed above, the simulator and associated scientific modules can be used independently; please see the tvb-library folder.

Framework structure

tvb-gdist
    |
    |
tvb-library     tvb-data
      \          /
        \       /
        tvb.config
            |
            |
        tvb.core
            |
            |
        tvb.adapters
            |
            |
        tvb.config.init
            |
            |
        tvb.interfaces

tvb-data should be installed from Zenodo: https://zenodo.org/record/14992335. After download, unzip and execute pip install -e . in the correct env.

Usage

To use TVB code, clone from GitHub (https://github.com/the-virtual-brain/tvb-root), or get from Pypi:

pip install tvb-framework
python -m tvb.interfaces.web.run WEB_PROFILE tvb.config

Your port 8080 should be free, as a CherryPy service will try to run there. Your default browser should automatically open http://localhost:8080/ which is the way to interact with TVB Web Interface.

Testing

For testing the package, the Pytest framework is used. Pytest can be installed using pip.

In addition to tvb-framework needed just for launching the web, tests require few extra dependencies just for test (e.g. pytest-benchmark), which need to be installed manually. The entire list of these dependencies for testing is found in tvb_framework/pyproject.toml under project.optional-dependencies.

Pytest will run all files in the current directory and its subdirectories of the form test_*.py or *_test.py. More generally, it follows standard test discovery rules

The command for running our tests has two forms. Recommendation when working with a git clone of tvb-framework:

cd [folder_where_tvb_framework_is]
pytest tvb/test/framework [--profile=TEST_POSTGRES_PROFILE] [--junitxml=path]
# default profile value is TEST_SQLITE_PROFILE

The second alternative form of running TVB tests, when installing TVB from Pypi, is:

pip install -U tvb-framework
pytest --pyargs tvb.tests.framework

Coverage

A coverage report can be generated with:

pip install pytest-cov
cd [folder_where_tvb_framework_is]
py.test --cov=tvb tvb/tests/ --cov-branch --cov-report xml:[file_where_xml_will_be_generated]

Further Resources

Acknowledgments

This project has received funding from the European Union’s Horizon 2020 Framework Programme for Research and Innovation under the Specific Grant Agreement Nos. 785907 (Human Brain Project SGA2), 945539 (Human Brain Project SGA3) and VirtualBrainCloud 826421.

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

Metadata

Release files for tvb-framework 3.0.0a1

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-framework 3.0.0a1
File Size Uploaded Provenance Actions
tvb_framework-3.0.0a1.tar.gz 10.1 MB Without provenance Details for tvb_framework-3.0.0a1.tar.gz

Built distribution (wheel)

Table of built distributions (wheels) for tvb-framework 3.0.0a1
File Interpreter ABI Platform Actions
tvb_framework-3.0.0a1-py3-none-any.whl Python 3 none any Details for tvb_framework-3.0.0a1-py3-none-any.whl

Total release size: 21.4 MB

Release files / tvb_framework-3.0.0a1.tar.gz

Download URL tvb_framework-3.0.0a1.tar.gz
Size 10.1 MB
Tags Source
SHA-256 checksum
How to use checksums
827306b80a1119f6c8440601aeba466bfda1978ce26567d55e1077b5af5a4aea
BLAKE2b-256 checksum
How to use checksums
8bc70af444e79007b61b6093e95fa52c281d26ee4b39cf9638fb2d2d23c06618
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via twine/7.0.0 CPython/3.13.18

Release files / tvb_framework-3.0.0a1-py3-none-any.whl

Download URL tvb_framework-3.0.0a1-py3-none-any.whl
Size 11.4 MB
Tags Python 3
SHA-256 checksum
How to use checksums
f67915781d4b110c4cc53265da282adfbfff642802fe76b4d29d70898047b472
BLAKE2b-256 checksum
How to use checksums
6cbf478fdfafdf0795afb47910bdcb1145e305c9fea3832da1cbd3d75a73b351
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via twine/7.0.0 CPython/3.13.18

Security for tvb-framework 3.0.0a1

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