Developer Guides

This section contains internal documentation for NEST developers. It covers architecture decisions, design rationale, coding conventions, and other material relevant to contributors working on the NEST source code. The entire C++ codebase is rendered with Doxygen (see below).

Please ensure you are familiar with all the relevant workflows for contributing code and documentation.

If you have ideas on improving these docs or if you find errors, please create an issue on GitHub!

Contents

• Architecture Overview — High-level structure of the NEST simulator: subsystems, their responsibilities, and how they interact.
• Design Decisions — A log of significant architectural and API choices, with the context and reasoning behind them.
• Coding Conventions — C++ style rules, naming schemes, and patterns used throughout the codebase.
• Developer Documentation Workflow — How to write Doxygen comments, build docs locally, and review the CI artifact on pull requests.

C++ code documentation

• nest namespace
• Class list
• All namespaces
• File list