Package: tvb-framework
TVB FRAMEWORKThe 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 detailsin 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
thetvb-libraryfolder.Framework structuretvb-gdist
    |
    |
tvb-library     tvb-data
      \          /
        \       /
        tvb.config
            |
            |
        tvb.core
            |
            |
        tvb.adapters
            |
            |
        tvb.config.init
            |
            |
        tvb.interfacestvb-datashould be installed fromZenodo:https://zenodo.org/record/8331301.
After download, unzip and executepython setup.py developin the correct env.UsageTo 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.configYour port8080should be free, as a CherryPy service will try to run there.
Your default browser should automatically openhttp://localhost:8080/which is the way to
interact with TVB Web Interface.TestingFor testing the package, thePytestframework 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 intvb_framework/setup.pyunderextras_require.Pytest will run all files in the current directory and its subdirectories
of the form test_*.py or *_test.py.
More generally, it followsstandard test discovery rulesThe 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_PROFILEThe second alternative form of running TVB tests, when installing TVB from Pypi, is:pip install -U tvb-framework
pytest --pyargs tvb.tests.frameworkCoverageA 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 ResourcesFor issue tracking we are using Jira:http://req.thevirtualbrain.orgFor API documentation and live demos, have a look here:http://docs.thevirtualbrain.orgA public mailing list for users of The Virtual Brain can be joined
and followed using:tvb-users@googlegroups.comRaw demo IPython Notebooks can be found under:https://github.com/the-virtual-brain/tvb-root/tree/master/tvb_documentation/demosAcknowledgmentsThis 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.