TVB-O logo TVB-O Documentation
  • Home
  • Usage
  • Data Model
  • Platform
  1. Usage
  • Home
  • Installation
  • Quick Reference
    • Examples
  • Usage
    • Fundamentals
      • Getting Started
      • Defining Dynamical Systems
      • Defining Networks
      • Coupling Functions
      • Integrators
      • Simulation Experiments
      • The Experiment Result
      • Code Generation
    • Observation & Analysis
      • Observation Models
      • Algorithms
      • Loss Functions
      • Parameter Exploration
      • Model Fitting
      • Bifurcation Analysis
      • Visualization
      • Output Specification
    • Simulation Features
      • Events & Stimulation
      • Noise & Stochastic Integration
    • Advanced
      • Creating Custom Networks
      • PDE Simulation
      • Heterogeneous Node Dynamics
      • Heterogeneous Edge Dynamics
      • Unit-Aware Computations
  • Interoperability
    • The Virtual Brain (TVB)
      • Connectome
      • Monitors
    • tvboptim Backend
      • Jansen-Rit
      • Reduced Wong-Wang
      • EI Tuning
    • PyRates
      • Round-Trip Demo
      • Analysis
      • Bifurcation
      • Heterogeneous Networks
    • NetworkDynamics.jl
      • Network Diffusion
      • 2D Network Diffusion
      • Kuramoto Oscillators
      • Heterogeneous Kuramoto
      • FitzHugh-Nagumo
      • Cascading Failure
      • Stress on Truss
    • BifurcationKit.jl
      • Tsodyks-Markram Model
      • CO Oxidation Model
    • ModelingToolkit.jl
      • Higher-Order ODE Lowering
    • NeuroML / LEMS
      • LEMS Export
      • LEMS Examples
        • Interoperability
          • NeuroML
            • Examples
              • Ex0: Integrate-and-Fire
              • Ex1: Hodgkin-Huxley
              • Ex10: Q10 Temperature Dependence
              • Ex11: STDP
              • Ex12: Network 2
              • Ex13: Population Instances
              • Ex14: PyNN Cells
              • Ex15: Calcium Dynamics
              • Ex16: Input Types
              • Ex17: Tissue Simulation
              • Ex18: Goldman-Hodgkin-Katz
              • Ex19: Gap Junctions
              • Ex2: Izhikevich
              • Ex20: Analog Synapses
              • Ex21: Current-Based Synapses
              • Ex22: Pinsky-Rinzel CA3
              • Ex23: Spike Times
              • Ex24: Fractional Conductance
              • Ex25: Multi-Compartment Cells
              • Ex26: Connection Weights
              • Ex27: Multi-Synapses
              • Ex3: HH Network with Synapses
              • Ex4: Kinetic Scheme Channels
              • Ex5: Detailed HH Cell
              • Ex6: NMDA Synapse
              • Ex7: Short-Term Plasticity
              • Ex8: Adaptive Exponential IF
              • Ex9: FitzHugh-Nagumo
      • NML2 File Documentation
        • Interoperability
          • NeuroML
            • Examples
              • NML2: Abstract Cells
              • NML2: Analog Synapses
              • NML2: Full Cell
              • NML2: Full NeuroML
              • NML2: Gap Junctions
              • NML2: Inputs
              • NML2: Instance-Based Network
              • NML2: Simple Ion Channel
              • NML2: Simple Morphology
              • NML2: Single-Compartment HH Cell
              • NML2: Synapse Types
    • BIDS
      • BIDS Export
      • Computational Modelling
    • OpenMINDS
      • OpenMINDS Interoperability

  • Platform
  • Replication Studies
    • Jansen & Rit (1995)

  • Data Model
    • Schemas
      • SANDS
      • tvb-datamodel
      • tvb_dbs
      • types
    • Classes
      • Aggregation
      • Algorithm
      • Algorithm Include
      • Argument
      • Bids Entities
      • Boundary Condition
      • Brain Atlas
      • Brain Region Series
      • Branch Switch
      • Callable
      • Case
      • Class Reference
      • Clinical Improvement
      • Clinical Scale
      • Clinical Score
      • Common Coordinate Space
      • Conditional Block
      • Contact
      • Continuation
      • Coordinate
      • Coupling
      • Coupling Input
      • Dataset
      • Data Source
      • DBSProtocol
      • Derived Observation
      • Derived Parameter
      • Derived Variable
      • Differential Operator
      • Discretization
      • Distribution
      • Dynamics
      • Edge
      • EField
      • Electrode
      • Equation
      • Event
      • Execution Config
      • Exploration
      • Field State Variable
      • File
      • Function
      • Function Call
      • Graph Generator
      • Initial State
      • Integrator
      • Loss Function
      • Matrix
      • Mesh
      • NDArray
      • Network
      • Node
      • Noise
      • Observation
      • Optimization
      • Optimization Stage
      • Option
      • Parameter
      • Parcellation
      • Parcellation Entity
      • Parcellation Terminology
      • PDE
      • PDESolver
      • Provenance
      • Random Stream
      • Range
      • Region Mapping
      • Sample
      • Simulation Experiment
      • Simulation Study
      • Software Environment
      • Software Package
      • Software Requirement
      • Solver
      • Spatial Domain
      • Spatial Field
      • State Value
      • State Variable
      • Stimulation Setting
      • Stimulus
      • Subject
      • Temporal Applicable Equation
      • Time Series
      • Tractogram
      • Tuning Objective
      • Update Rule
    • Slots
      • abbreviation
      • abs_tol
      • absolute_value
      • accelerator
      • acquisition
      • acronym
      • active_contacts
      • additional_equations
      • additive
      • affect
      • affect_negative
      • affect_parameters
      • affect_states
      • age
      • aggregate
      • aggregation
      • algorithm
      • algorithms
      • alternate Name
      • amplitude
      • anatomical Axes Orientation
      • apply_every
      • apply_on_dimension
      • arguments
      • atlas
      • author
      • autonomous
      • average
      • axes Origin
      • axis
      • baseline_value
      • batch_size
      • bc_type
      • bids
      • bids_dir
      • bothside
      • boundaries
      • boundary_conditions
      • bounds
      • branches
      • build_hash
      • call_args
      • callable
      • cases
      • center
      • class_call
      • class_reference
      • clinical_improvement
      • clinical_scores
      • coefficient
      • cohort
      • color
      • comment
      • condition
      • condition_parameters
      • condition_states
      • conditional
      • conditionals
      • connectivity
      • connectivity_ref
      • constructor_args
      • contact_id
      • contacts
      • container_image
      • continuation
      • continuations
      • coordinate
      • coordinate_space
      • coordinates
      • coordinate Space
      • correlated
      • correlation
      • coupling
      • coupling_function
      • coupling_inputs
      • coupling_terms
      • coupling_variable
      • data
      • data_file
      • data_source
      • data Location
      • dataset_id
      • dataset_path
      • date_created
      • default
      • default Image
      • definition
      • degree
      • delayed
      • delta_p
      • depends_on
      • derivative_initial_value
      • derived_from
      • derived_from_model
      • derived_observations
      • derived_parameters
      • derived_variables
      • description
      • descriptor
      • detect_bifurcation
      • detect_fold
      • diagnosis
      • digital Identifier
      • dimension
      • dimension_labels
      • directed
      • discretization
      • distance_unit
      • distribution
      • doi
      • domain
      • downsample_period
      • ds
      • ds_max
      • ds_min
      • dt
      • dtype
      • duration
      • dynamics
      • ecosystem
      • edge_matrix_files
      • edges
      • efield
      • electrode_id
      • electrode_reference
      • electrodes
      • element
      • element_domains
      • element_type
      • elements
      • engine
      • entities
      • environment
      • environment_type
      • equation
      • equation_order
      • equation_type
      • evaluator
      • event_type
      • events
      • execution
      • explorations
      • explored_values
      • expression
      • extension
      • field
      • field_dynamics
      • file
      • find_fixpoint
      • format
      • free
      • free_parameters
      • freeze_parameters
      • frequency
      • function
      • functions
      • gaussian
      • generated_at
      • generated_by
      • geometry
      • graph_generator
      • groups
      • handedness
      • has_reference
      • hash
      • has Parent
      • head
      • hemisphere
      • heterogeneous
      • hi
      • history
      • homepage
      • hyperparameters
      • id
      • imaging_modality
      • includes
      • incoming_states
      • initial_expression
      • initial_state
      • initial_value
      • inner_coupling
      • input
      • integration
      • intensity
      • intermediate_expressions
      • iri
      • is Version Of
      • key
      • keys
      • label
      • labels_dimensions
      • labels_ordering
      • latex
      • learning_rate
      • learning_rate_schedule
      • learning_rate_warmup
      • lefthandside
      • license
      • linear_solver
      • lo
      • loader
      • local_coupling_term
      • local_states
      • log_scale
      • lookup Label
      • loss
      • manufacturer
      • max_bisection_steps
      • max_iterations
      • max_steps
      • mesh
      • mesh_file
      • mesh_format
      • mesh_intervals
      • method
      • metric
      • modality
      • mode
      • model
      • model_equation_ref
      • model_param_ref
      • model_type
      • modes
      • modified
      • module
      • modules
      • n
      • n_inversion
      • n_iterations
      • n_parallel
      • n_regions
      • n_sections
      • n_threads
      • n_trials
      • n_vertices
      • n_workers
      • name
      • native Unit
      • network
      • nev
      • newton_max_iterations
      • newton_tol
      • node_mapping
      • nodes
      • noise
      • noise_type
      • non_negative
      • notes
      • number_of_elements
      • number_of_modes
      • number_of_nodes
      • number_of_stages
      • number_of_subjects
      • number_of_vertices
      • objective
      • observable
      • observational_measures
      • observations
      • observed
      • ode_solver
      • on_region
      • ontology Identifier
      • operator_type
      • operators
      • optimizations
      • optional
      • options
      • original Lookup Label
      • output
      • output_equation
      • outsym
      • over
      • package
      • parameters
      • parcellation
      • parent_network
      • parent_score
      • path
      • percent_change
      • period
      • pipeline
      • platform
      • position
      • post_expression
      • pre_expression
      • precision
      • preconditioner
      • preprocessing
      • processing_pipeline
      • protocols
      • provenance
      • pulse_width
      • pycode
      • quantity_kind
      • random_seed
      • random_state
      • recon_path
      • reconstruction
      • reference
      • references
      • region
      • region_mapping
      • regional_connectivity
      • regions
      • rel_tol
      • related UBERONTerm
      • reported_optimum
      • repository
      • requirements
      • requires
      • righthandside
      • role
      • run_id
      • sample
      • sampling_period
      • sampling_period_unit
      • sampling_rate
      • scale
      • scipy_ode_base
      • score
      • seed
      • segmentation
      • session_id
      • settings
      • sex
      • shape
      • simulation_experiments
      • simulation_period
      • size
      • skip_t
      • software
      • software_environment
      • solver
      • source
      • source_branch
      • source_code
      • source_experiment
      • source_observations
      • source_point
      • source_url
      • source_var
      • sources
      • sparse
      • stages
      • state
      • state_variables
      • state_wise_sigma
      • step
      • step_size
      • steps
      • stimulation
      • stimulation_variable
      • stimulus
      • structural_measures
      • subject_id
      • subjects
      • symbol
      • symmetry
      • system_type
      • tail
      • tail_samples
      • target
      • target_component
      • target_data
      • target_network
      • target_parameter
      • target_structure
      • target_value
      • target_var
      • target_variable
      • targets
      • task_name
      • template
      • tensor_coefficient
      • terminology
      • threshold_applied
      • time
      • time_dependent
      • time_integrator
      • time_post_surgery
      • time_range
      • time_scale
      • time_unit
      • timepoint
      • timing_info
      • title
      • tol_stability
      • tolerances
      • tractogram
      • trajectory
      • transforms
      • transient_time
      • trigger_times
      • type
      • unit
      • update_expression
      • update_rules
      • url
      • valid_diagonal
      • value
      • values
      • variable_of_interest
      • version
      • version_spec
      • version Identifier
      • vertex_to_region
      • voi
      • volume_data
      • warmup
      • warmup_from
      • warmup_source
      • weighted
      • weighting
      • window_size
      • x
      • y
      • year
      • z
    • Enumerations
      • Aggregation Type
      • Boundary Condition Type
      • Continuation Algorithm
      • Dimension Type
      • Discretization Method
      • Element Type
      • Environment Type
      • Event Type
      • Hemisphere
      • Imaging Modality
      • Initial State Method
      • Model Type
      • Noise Type
      • Numerical Discretization Method
      • Operator Type
      • Physical Dimension
      • Reduction Type
      • Requirement Role
      • Sampling Axis
      • Sparse Format
      • Specimen Enum
      • Standard Graph Type
      • System Type
      • Unit Enum
  • API Documentation
    • Adapters
      • Base
      • Bids
      • Bifurcationkit
      • Diffeq
      • Julia
      • Modelingtoolkit
      • Networkdynamics
      • Neuroml
      • Openminds
      • Pyrates
      • Pyrates Bifurcation
      • Tvb
    • Analysis
      • Bifurcation
    • API
      • Direct Ontology Api
      • Dynamics Api
      • Experiment Api
      • Main
      • Network Api
      • Ontology Api
    • Classes
      • Atlas
      • Continuation
      • Coupling
      • Dynamics
      • Equation
      • Experiment
      • Function
      • Network
      • Noise
      • Observation
      • Parcellation
      • Perturbation
      • Study
    • TVB-O Code Generation
      • Code
      • Cuda
      • Functions
      • Lems
      • Pyrates
      • Templater
    • Data
      • Converters
      • Matrix Io
      • Network Io
      • Registry
      • Types
    • Data Model
      • Pydantic
      • Schema
    • Export
      • Report
    • TVB-O Ontology
      • Config
      • Constants
      • Db
      • Graph
      • Owl
      • Query
      • Atlas
        • Freesurfer
      • Semantic Web
        • Tvbgo
    • Parse
      • Expression
      • Lems Loader
      • Tvb Converter
    • Plot
      • Analysis
      • Animate
      • Bifurcation Diagram
      • Functions
      • Network
      • Network Graph
      • Ontology
      • Phase
      • Timeseries
      • Utils
    • Run
      • Compgraph
      • Graph
      • Julia
    • Templates
      • RateML
        • Utils
      • tvboptim
        • Utils
    • Utilities
      • Report
      • Units
  • Developer

Usage Guide

Learn how to use TVBO for defining, simulating, and analyzing brain network models.

Examples
Getting Started
 

© 2025 Charité - Universitätsmedizin Berlin

  • Edit this page
  • Report an issue