TVB-O Documentation

Home
Usage
Data Model
Platform

API Documentation
from tvbo.jax import xarray_pytrees # noqa: F401 – side effect: registers pytrees
Xarray Pytrees

Home
Installation
Quick Reference
- Examples
Usage
Interoperability
Platform
Replication Studies
- Jansen & Rit (1995)
Data Model
- Schemas
  - SANDS
  - software
  - tvb-datamodel
  - tvb_dbs
  - tvbo_study
  - types
- Classes
- 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
  - application_category
  - apply_every
  - apply_on_dimension
  - arguments
  - atlas
  - author
  - autonomous
  - average
  - axes Origin
  - axis
  - baseline_value
  - batch_size
  - bc_type
  - bids
  - bids_dir
  - bids_root
  - bothside
  - boundaries
  - boundary_conditions
  - bounds
  - branches
  - build_hash
  - call_args
  - callable
  - cases
  - center
  - citation
  - class_call
  - class_reference
  - clinical_improvement
  - clinical_scores
  - coefficient
  - cohort
  - color
  - comment
  - condition
  - condition_parameters
  - condition_states
  - conditional
  - conditionals
  - conditions
  - 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
  - dataset_id
  - dataset_path
  - date_created
  - date_modified
  - 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
  - development_status
  - 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
  - empirical_data
  - 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
  - funder
  - gaussian
  - generated_at
  - generated_by
  - geometry
  - graph_generator
  - group
  - 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
  - interoperates_with
  - iri
  - is_accessible_for_free
  - issue_tracker
  - is Version Of
  - key
  - keys
  - keywords
  - 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
  - maintainer
  - manufacturer
  - max_bisection_steps
  - max_iterations
  - max_steps
  - mesh
  - mesh_file
  - mesh_format
  - mesh_intervals
  - metadata
  - method
  - metric
  - modality
  - mode
  - model
  - model_equation_ref
  - model_paradigm
  - 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
  - operating_system
  - 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
  - programming_language
  - protocols
  - provenance
  - pulse_width
  - pycode
  - quantity_kind
  - random_seed
  - random_state
  - recon_path
  - reconstruction
  - record
  - reference
  - reference_publication
  - references
  - region
  - region_mapping
  - regional_connectivity
  - regions
  - rel_tol
  - related UBERONTerm
  - reported_optimum
  - repository
  - requirements
  - requires
  - righthandside
  - role
  - run_id
  - runtime_platform
  - same_as
  - sample
  - sampling_period
  - sampling_period_unit
  - sampling_rate
  - scale
  - scipy_ode_base
  - score
  - seed
  - segmentation
  - session_id
  - sessions
  - 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
  - tool_role
  - 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
API Documentation
- Adapters
  - Base
  - Bids
  - Bifurcationkit
  - Diffeq
  - Julia
  - Modelingtoolkit
  - Networkdynamics
  - Neuroml
  - Openminds
  - Pyrates
  - Pyrates Bifurcation
  - Tvb
  - Tvboptim
- Analysis
  - Bifurcation
- 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
- from tvbo.jax import xarray_pytrees # noqa: F401 – side effect: registers pytrees
  - Xarray Pytrees
- TVB-O Ontology
  - Config
  - Constants
  - Db
  - Graph
  - Owl
  - Query
  - Atlas
    - Freesurfer
  - Semantic Web
    - Tvbgo
- Parse
- 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

On this page

xarray_pytrees

Edit this page
Report an issue

API Documentation
from tvbo.jax import xarray_pytrees # noqa: F401 – side effect: registers pytrees
Xarray Pytrees

xarray_pytrees

jax.xarray_pytrees

Register xarray data structures as JAX pytree nodes.

from tvbo.jax import xarray_pytrees # noqa: F401 – side effect: registers pytrees

© 2025 Charité - Universitätsmedizin Berlin

Edit this page
Report an issue