Developer Guide

Developer Guide#

Welcome to the brainmass developer documentation! This guide helps you contribute to the project.

Getting Started#

Contributing

How to contribute code, docs, or examples

Contributing Guide
Architecture

Package design and organization

Architecture
Creating Models

Build custom neural mass models

Creating Custom Models
Testing

Testing guidelines and practices

Testing

Extending brainmass#

These guides document the stable extension contracts — the public APIs you build custom pieces against, so they slot into the orchestration layer (and future data-driven tooling) exactly like the built-ins.

Building a Data-Driven Workflow

The extension playbook: trainable params → custom loss → Fitter / training loop → vmap

Building a Data-Driven Workflow
Extending Noise

Implement custom noise processes

Extending Noise Processes
Creating a Coupling

Implement a new network coupling (prefetch/delay contract)

Creating a Coupling
Creating an Objective

Write a composable loss that works across all Fitter backends

Creating an Objective

Quick Start for Contributors#

  1. Fork and Clone:

    git clone https://github.com/YOUR_USERNAME/brainmass.git
cd brainmass

  2. Install Development Dependencies:

    pip install -e .[dev,doc]

  3. Create a Branch:

    git checkout -b feature/my-new-feature

  4. Make Changes and Test:

    pytest brainmass/
make -C docs html

  5. Submit Pull Request:

    Push your branch and open a PR on GitHub

Code of Conduct#

We are committed to providing a welcoming and inclusive environment. Please be respectful and professional in all interactions.

Key principles:

  • Be kind and courteous

  • Respect differing opinions

  • Focus on constructive feedback

  • Assume good intentions

Getting Help#

  • Questions: Open a discussion on GitHub

  • Bugs: Report issues on GitHub

  • Feature requests: Open an issue with the “enhancement” label

  • Chat: Join our community (link TBD)

See Also#