Skip to content



To begin using pyBrainGenixClient in your research or development projects, complete the following steps:


  • Verify that Python 3 is installed on your computer. Python 3.7 or higher is recommended for optimal performance and compatibility.
  • Install pip if it's not already included in your Python setup. pip is the package manager for Python that allows you to install packages from the Python Package Index (PyPI). If you don't have it, you can install it by running sudo apt install python3-pip in your terminal.


We've only tested that this package works on Linux systems (debian based), and as such it may not work on other operating systems.

Installing pyBrainGenixClient

  1. Open your terminal or command prompt.
  2. Use pip to install pyBrainGenixClient by entering the following command:
    pip install pyBrainGenixClient
  3. Once installation is complete, you can import the package into your Python scripts or interact with it using the command line tools provided.

Getting Started with pyBrainGenixClient

  • After installation, refer to the documentation or example scripts within the package to understand how to create simulations, manage components, and interact with remote servers.
  • Join the BrainGenix community to stay informed about updates, share knowledge, and seek assistance from other users and developers.
  • Explore additional resources such as tutorials, webinars, and developer forums to deepen your understanding of neural simulation creation using pyBrainGenixClient.

This documentation is provided by BrainGenix, a division of Carboncopies Foundation R&D. BrainGenix is a platform focused on advancing the field of whole-brain-emulation and computational neuroscience. BrainGenix is part of the CarbonCopies Foundation, a 501(c)3 non-profit organization dedicated to researching and promoting whole brain emulation. Learn more about CarbonCopies at For any queries or feedback regarding BrainGenix projects or documentation, please write to us at