Source code for tvb.config.algorithm_categories

# -*- coding: utf-8 -*-
# TheVirtualBrain-Framework Package. This package holds all Data Management, and
# Web-UI helpful to run brain-simulations. To use it, you also need to download
# TheVirtualBrain-Scientific Package (for simulators). See content of the
# documentation-folder for more details. See also
# (c) 2012-2023, Baycrest Centre for Geriatric Care ("Baycrest") and others
# This program is free software: you can redistribute it and/or modify it under the
# terms of the GNU General Public License as published by the Free Software Foundation,
# either version 3 of the License, or (at your option) any later version.
# This program is distributed in the hope that it will be useful, but WITHOUT ANY
# WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A
# PARTICULAR PURPOSE.  See the GNU General Public License for more details.
# You should have received a copy of the GNU General Public License along with this
# program.  If not, see <>.
# When using The Virtual Brain for scientific publications, please cite it as explained here:


[docs] class AlgorithmCategoryConfig(object): """ Base class to define defaults for an algorithm category entity. To be overiden inside each algorithm category module: analyzers, creators, simulator, uploaders, visualizers. Subclasses will be used at introspection time, in order to fill the ALGORITHM_CATEGORIES table with data. """ category_name = None rawinput = False display = False launchable = False defaultdatastate = DEFAULTDATASTATE_INTERMEDIATE order_nr = 999
[docs] class AnalyzeAlgorithmCategoryConfig(AlgorithmCategoryConfig): category_name = 'Analyze' launchable = True order_nr = 1
[docs] class CreateAlgorithmCategoryConfig(AlgorithmCategoryConfig): category_name = 'Create' defaultdatastate = DEFAULTDATASTATE_RAW_DATA order_nr = 0
[docs] class SimulateAlgorithmCategoryConfig(AlgorithmCategoryConfig): category_name = 'Simulate' order_nr = 0
[docs] class UploadAlgorithmCategoryConfig(AlgorithmCategoryConfig): category_name = 'Upload' rawinput = True defaultdatastate = DEFAULTDATASTATE_RAW_DATA order_nr = 999
[docs] class ViewAlgorithmCategoryConfig(AlgorithmCategoryConfig): category_name = 'View' display = True launchable = True order_nr = 3