tvb-library


Nametvb-library JSON
Version 2.8.1 PyPI version JSON
download
home_pagehttps://www.thevirtualbrain.org
SummaryA package for performing whole brain simulations
upload_time2023-05-23 18:41:23
maintainer
docs_urlNone
authorMarmaduke Woodman, Jan Fousek, Stuart Knock, Paula Sanz Leon, Viktor Jirsa
requires_python
licenseGPL-3.0-or-later
keywords tvb brain simulator neuroscience human animal neuronal dynamics models delay
VCS
bugtrack_url
requirements No requirements were recorded.
Travis-CI No Travis.
coveralls test coverage
            THE VIRTUAL BRAIN SCIENTIFIC LIBRARY
====================================

The Virtual Brain Project (TVB Project) has the purpose of offering some
modern tools to the Neurosciences community, for computing, simulating
and analyzing functional and structural data of human brains.

"TVB Scientific Library" is the most important scientific contribution
of TVB Project, but only a part of our code. In order to use this TVB
Python Library (modify/run/test), you are advised to follow the steps
described here:
http://docs.thevirtualbrain.com/manuals/ContributorsManual/ContributorsManual.html#contributors-manual

The interaction with TVB source code is recommended for advanced users
only, for which the concepts proposed by TVB are known and understood,
and which also have some programming knowledge.

"TVB Scientific Library" comes in two major forms for code-contributors:
as a light-weight Python library, or plugged into TVB framework
(including Web interface and Persistence of data layers). Depending on
your needs and resources, you could use any of the two available options
for contributing and testing new code.

"TVB Scientific Library" is a light-weight, stand-alone Python library
that contains all the needed packages in order to run simulations and
analysis on data without the need for the entire TVB Framework. This
implies that no storage will be provided so data from each session will
be lost on close. You need to either persist it yourself in some manner
or use the full TVBFramework where HDF5 / database storage is provided
as default.

For more details, check: http://www.thevirtualbrain.org/

"TVB Scientific Library" contains the following packages: basic,
datatypes, simulator and analyzers. The dependencies between these
packages can be seen in tvb-package-diagram.jpg . Following is a short
description of each of these packages:

-  tvb.basic

This package is the base of TVB and holds sub-packages that are used by
most of the other packages like logging, global settings and the TVB
traits package. You should rarely (if at all) need to change code in
this package, and should know exactly what you are doing before
attempting to change anything from here.

-  tvb.datatypes

The simulator and analyzers packages (as well as uploaders and
visualizers in TVB Framework) will need to have a common "language" in
order to work with the same data. In TVB architecture, that "common
language" is represented by Data Types. TVB Data Types declarations are
located in this package.

-  tvb.simulator

The Simulation Component is the most important component in The Virtual
Brain solution, as it is the component responsible for all the
scientific computation related to brain models and data.

You can find various demos of using the simulator here:
http://docs.thevirtualbrain.org/demos/Demos.html .

-  tvb.analyzers

Holds modules that can run various analysis of data resulted from the
simulator. TVB is not strong in
doing data analysis, we barely have a minimum set of analyzers for
immediate needs.

NOTE:

To contribute to this repo, you are advised to first fork it under
GitHub (through the web ui), and next clone that fork on your machine,
and use it as you use any other git repository.

Testing
=======

For testing the package, the `Pytest  <https://docs.pytest.org/>`_
framework is used. Pytest can be installed using pip.

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
<https://docs.pytest.org/en/latest/getting-started.html>`_

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

    cd [folder_where_tvb_library_is]
    pytest tvb/test [--junitxml=path]

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

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


Coverage
--------

A coverage report can be generated with::

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


Further Resources
=================

-  For issue tracking we are using Jira: http://req.thevirtualbrain.org
-  For API documentation and live demos, have a look here:
   http://docs.thevirtualbrain.org
-  A public mailing list for users of The Virtual Brain can be joined
   and followed using: tvb-users@googlegroups.com
-  Raw demo IPython Notebooks can be found under:
   https://github.com/the-virtual-brain/tvb-root/tree/master/tvb_documentation/demos


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.

            

Raw data

            {
    "_id": null,
    "home_page": "https://www.thevirtualbrain.org",
    "name": "tvb-library",
    "maintainer": "",
    "docs_url": null,
    "requires_python": "",
    "maintainer_email": "",
    "keywords": "tvb brain simulator neuroscience human animal neuronal dynamics models delay",
    "author": "Marmaduke Woodman,  Jan Fousek, Stuart Knock, Paula Sanz Leon, Viktor Jirsa",
    "author_email": "tvb.admin@thevirtualbrain.org",
    "download_url": "https://files.pythonhosted.org/packages/f3/0a/1720c56dcf3fa730510350ccb23624571fe6e74dd664a67cf5db27b84557/tvb-library-2.8.1.tar.gz",
    "platform": null,
    "description": "THE VIRTUAL BRAIN SCIENTIFIC LIBRARY\n====================================\n\nThe Virtual Brain Project (TVB Project) has the purpose of offering some\nmodern tools to the Neurosciences community, for computing, simulating\nand analyzing functional and structural data of human brains.\n\n\"TVB Scientific Library\" is the most important scientific contribution\nof TVB Project, but only a part of our code. In order to use this TVB\nPython Library (modify/run/test), you are advised to follow the steps\ndescribed here:\nhttp://docs.thevirtualbrain.com/manuals/ContributorsManual/ContributorsManual.html#contributors-manual\n\nThe interaction with TVB source code is recommended for advanced users\nonly, for which the concepts proposed by TVB are known and understood,\nand which also have some programming knowledge.\n\n\"TVB Scientific Library\" comes in two major forms for code-contributors:\nas a light-weight Python library, or plugged into TVB framework\n(including Web interface and Persistence of data layers). Depending on\nyour needs and resources, you could use any of the two available options\nfor contributing and testing new code.\n\n\"TVB Scientific Library\" is a light-weight, stand-alone Python library\nthat contains all the needed packages in order to run simulations and\nanalysis on data without the need for the entire TVB Framework. This\nimplies that no storage will be provided so data from each session will\nbe lost on close. You need to either persist it yourself in some manner\nor use the full TVBFramework where HDF5 / database storage is provided\nas default.\n\nFor more details, check: http://www.thevirtualbrain.org/\n\n\"TVB Scientific Library\" contains the following packages: basic,\ndatatypes, simulator and analyzers. The dependencies between these\npackages can be seen in tvb-package-diagram.jpg . Following is a short\ndescription of each of these packages:\n\n-  tvb.basic\n\nThis package is the base of TVB and holds sub-packages that are used by\nmost of the other packages like logging, global settings and the TVB\ntraits package. You should rarely (if at all) need to change code in\nthis package, and should know exactly what you are doing before\nattempting to change anything from here.\n\n-  tvb.datatypes\n\nThe simulator and analyzers packages (as well as uploaders and\nvisualizers in TVB Framework) will need to have a common \"language\" in\norder to work with the same data. In TVB architecture, that \"common\nlanguage\" is represented by Data Types. TVB Data Types declarations are\nlocated in this package.\n\n-  tvb.simulator\n\nThe Simulation Component is the most important component in The Virtual\nBrain solution, as it is the component responsible for all the\nscientific computation related to brain models and data.\n\nYou can find various demos of using the simulator here:\nhttp://docs.thevirtualbrain.org/demos/Demos.html .\n\n-  tvb.analyzers\n\nHolds modules that can run various analysis of data resulted from the\nsimulator. TVB is not strong in\ndoing data analysis, we barely have a minimum set of analyzers for\nimmediate needs.\n\nNOTE:\n\nTo contribute to this repo, you are advised to first fork it under\nGitHub (through the web ui), and next clone that fork on your machine,\nand use it as you use any other git repository.\n\nTesting\n=======\n\nFor testing the package, the `Pytest  <https://docs.pytest.org/>`_\nframework is used. Pytest can be installed using pip.\n\nPytest will run all files in the current directory and its subdirectories\nof the form test_*.py or \\*_test.py.\nMore generally, it follows `standard test discovery rules\n<https://docs.pytest.org/en/latest/getting-started.html>`_\n\nThe command for running our tests has two forms.\nRecommendation when working with a git clone of tvb-library::\n\n    cd [folder_where_tvb_library_is]\n    pytest tvb/test [--junitxml=path]\n\nThe second alternative form of running TVB tests, when installing TVB from Pypi, is::\n\n    pip install -U tvb-library\n    pytest --pyargs tvb.tests.library\n\n\nCoverage\n--------\n\nA coverage report can be generated with::\n\n    pip install pytest-cov\n    cd [folder_where_tvb_library_is]\n    py.test --cov-config .coveragerc --cov=tvb tvb/tests/ --cov-branch --cov-report xml:[file_where_xml_will_be_generated]\n\n\nFurther Resources\n=================\n\n-  For issue tracking we are using Jira: http://req.thevirtualbrain.org\n-  For API documentation and live demos, have a look here:\n   http://docs.thevirtualbrain.org\n-  A public mailing list for users of The Virtual Brain can be joined\n   and followed using: tvb-users@googlegroups.com\n-  Raw demo IPython Notebooks can be found under:\n   https://github.com/the-virtual-brain/tvb-root/tree/master/tvb_documentation/demos\n\n\nAcknowledgments\n===============\nThis project has received funding from the European Union\u2019s Horizon 2020 Framework Programme for Research and\nInnovation under the Specific Grant Agreement Nos. 785907 (Human Brain Project SGA2), 945539 (Human Brain Project SGA3)\nand VirtualBrainCloud 826421.\n",
    "bugtrack_url": null,
    "license": "GPL-3.0-or-later",
    "summary": "A package for performing whole brain simulations",
    "version": "2.8.1",
    "project_urls": {
        "Download": "https://github.com/the-virtual-brain/tvb-root",
        "Homepage": "https://www.thevirtualbrain.org"
    },
    "split_keywords": [
        "tvb",
        "brain",
        "simulator",
        "neuroscience",
        "human",
        "animal",
        "neuronal",
        "dynamics",
        "models",
        "delay"
    ],
    "urls": [
        {
            "comment_text": "",
            "digests": {
                "blake2b_256": "0291c97d8a8c4d9e531e3f0e6bf1b62fbaea1ef5026afd7b1afa240fcbf88bee",
                "md5": "1ed8ba5db232278cd2034c6bfd269651",
                "sha256": "eb8d07e90653e8aff48d76fe9d6a43d6dae87e222c8cc9eac7cbc9034c84b155"
            },
            "downloads": -1,
            "filename": "tvb_library-2.8.1-py3-none-any.whl",
            "has_sig": false,
            "md5_digest": "1ed8ba5db232278cd2034c6bfd269651",
            "packagetype": "bdist_wheel",
            "python_version": "py3",
            "requires_python": null,
            "size": 637005,
            "upload_time": "2023-05-23T18:40:26",
            "upload_time_iso_8601": "2023-05-23T18:40:26.454211Z",
            "url": "https://files.pythonhosted.org/packages/02/91/c97d8a8c4d9e531e3f0e6bf1b62fbaea1ef5026afd7b1afa240fcbf88bee/tvb_library-2.8.1-py3-none-any.whl",
            "yanked": false,
            "yanked_reason": null
        },
        {
            "comment_text": "",
            "digests": {
                "blake2b_256": "f30a1720c56dcf3fa730510350ccb23624571fe6e74dd664a67cf5db27b84557",
                "md5": "5ddce744db3cb034a6eb056ce2e0cc32",
                "sha256": "be130b10e7e176d503709afd211ae728f45d4e8b4a6082c6f6fcfbc1be990d0c"
            },
            "downloads": -1,
            "filename": "tvb-library-2.8.1.tar.gz",
            "has_sig": false,
            "md5_digest": "5ddce744db3cb034a6eb056ce2e0cc32",
            "packagetype": "sdist",
            "python_version": "source",
            "requires_python": null,
            "size": 409292,
            "upload_time": "2023-05-23T18:41:23",
            "upload_time_iso_8601": "2023-05-23T18:41:23.170751Z",
            "url": "https://files.pythonhosted.org/packages/f3/0a/1720c56dcf3fa730510350ccb23624571fe6e74dd664a67cf5db27b84557/tvb-library-2.8.1.tar.gz",
            "yanked": false,
            "yanked_reason": null
        }
    ],
    "upload_time": "2023-05-23 18:41:23",
    "github": true,
    "gitlab": false,
    "bitbucket": false,
    "codeberg": false,
    "github_user": "the-virtual-brain",
    "github_project": "tvb-root",
    "travis_ci": false,
    "coveralls": true,
    "github_actions": true,
    "lcname": "tvb-library"
}
        
Elapsed time: 0.08983s