Metadata-Version: 2.1
Name: tvb-library
Version: 1.5.5.1
Summary: A package for performing whole brain simulations
Home-page: http://www.thevirtualbrain.org
Author: Stuart Knock, Marmaduke Woodman, Paula Sanz Leon, Laurent Pezard, Viktor Jirsa
Author-email: tvb.admin@thevirtualbrain.org
License: GPL v3
Download-URL: https://github.com/the-virtual-brain/tvb-library
Description: 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.
        
        Most of the datatypes here have a diamond like inheritance structure of
        the following form:
        
        ::
        
                                    DataTypeData
                                         |
                                        / \\
                       DataTypeFramework   DataTypeScientific
                                        \ /
                                         |
                                      DataType
                                      
        
        The DataTypeData holds the actual structure of the datatype.
        DataTypeScientific holds any methods required from a scientific point of
        view. DataTypeFramework should just be ignored from a library user point
        of view as it holds framework related methods and will be removed
        altogether in the near future. DataType just brings all the above
        together and is the class you should actually use in your code.
        
        -  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 under
        tvb/simulator/demos as well as some nice tutorials under
        tvb/simulator/doc/tutorials/ .
        
        -  tvb.analyzers
        
        Holds modules that can run various analysis of data resulted from the
        simulator. There are a few demos which use the PCA analyzer like
        tvb/simulator/demos/pca\_analyse\_view\_region and
        tvb/simulator/demos/pca\_analyse\_view\_surface . 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.
        
        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-documentation/tree/master/demos
        
Keywords: tvb brain simulator neuroscience human animal neuronal dynamics models delay
Platform: UNKNOWN
Provides-Extra: tvb-data
