Contents Menu Expand Light mode Dark mode Auto light/dark, in light mode Auto light/dark, in dark mode Skip to content
Arbor documentation
Light Logo Dark Logo
Arbor documentation

Get started:

  • Get Arbor
    • Arbor Playground
    • Arbor GUI
    • Python Installation
    • Spack Installation
    • Build and install from source
  • Features
  • Tutorials
    • A simple single-cell model
    • Single Cell in GUI
    • A detailed single-cell model
    • A simple dendrite
    • A single-cell model from the Allen Brain Atlas
    • A single-cell model from the BluePyOpt Cell Optimisation Library
    • A simple single-cell recipe
    • A detailed single-cell recipe
    • A ring network
    • Two cells connected via a gap junction
    • Brunel network
    • Extracellular signals (LFPykit)
    • Spike-Timing-dependent Plasticity Curve
    • Distributed ring network (MPI)
    • GPU and profiling
    • How to use NMODL to extend Arbor’s repertoire of Ion Channels
    • Synapses in NMODL
    • Structural Plasticity in Arbor
    • Declarative Connectivity in Arbor
    • A Diffusion Process with Full Feedback
    • How to use MPI to generate coupled simulations at different scales
  • Ecosystem
  • Contributing
    • File an Issue
    • Make a Pull Request
    • Share a model
    • Write code
    • Modify documentation
    • Add examples
    • Add test
    • Release Procedure
    • GUI
    • Dependency management

Concepts:

  • Concepts overview
  • Recipes
  • Cells
  • Units in Arbor
  • Interconnectivity
  • Hardware context
  • Domain decomposition
  • Simulations
  • Probing and Sampling

Cell Types:

  • Cable cells
    • Cable cell morphology
    • Cable cell labels
    • Cable cell mechanisms
    • Cable cell decoration
    • Discretization
  • LIF cells
  • AdEx cells
  • Spike source cells
  • Benchmark cells

File formats:

  • File Formats
  • SWC
  • NeuroML2
  • Neurolucida ASCII
  • NMODL
  • Arbor Cable Cell
  • Checkpointing

API reference:

  • Python
    • Recipes
    • Cells
    • Interconnectivity
    • Remote Communication
    • Schedules
    • Event Generators
    • Hardware context
    • Domain decomposition
    • Simulations
    • Profiler
    • Meter manager
    • Cable cells
      • Cable cell morphology
      • Cable cell labels
      • Cable cell mechanisms
      • Cable cell decoration
      • Cable cell probing and sampling
      • LIF Cell probing
      • AdEx cell probing and sampling
      • Description Format
    • LIF cells
    • Spike source cells
    • Benchmark cells
    • Single-cell model
  • C++
    • Recipes
    • Cells
    • Interconnectivity
    • Remote Communication
    • Schedules
    • Event Generators
    • Hardware context
    • Domain decomposition
    • Cable cell mechanisms
    • Simulations
    • Profiler
    • Cable cells
      • Cable cell morphology
      • Supported morphology formats
      • Cable cell probing and sampling
      • LIF cell probing and sampling
      • AdEx cell probing and sampling
      • Description Format
    • LIF cells
    • Spike source cells
    • Cable cell labels
  • Developers Guide
    • How the Cable Cell is made
    • Cell groups
    • Communication in Arbor
    • Exchange of Spikes
    • Distribution of Events to Targets
    • Building the Connection Table
    • Debugging
    • Matrix Solvers
    • Stochastic Differential Equations
    • SIMD Classes
    • Shared State
    • Exporting Symbols
    • Adding Built-in Catalogues to Arbor
    • Mechanism ABI
    • Utility wrappers and containers
    • Version and build information
    • Numerical methods
Back to top
View this page

Get Arbor¶

  • To take a sneak preview of Arbor right here in your browser, navigate to the Arbor Playground.

  • To download and install Arbor on your system, enter pip install arbor in a terminal.

  • Download a Arbor GUI.

More and more advanced installation instructions (such as building Arbor with GPU or MPI support) can be found below:

  • Arbor Playground
  • Arbor GUI
  • Python Installation
  • Spack Installation
  • Build and install from source
Next
Arbor Playground
Previous
Home
Copyright © 2017-2026, ETHZ & FZJ
Made with Sphinx and @pradyunsg's Furo