Developer Builds

Developer builds for creating Binary and Python wheel distributions, tests, documentation, code coverage. Each aspect generally has extra dependencies and special instructions.

Tests overview

• In-tree CTest (build directory): enable with -DNRN_ENABLE_TESTS=ON, then ctest from the main build directory.

• Install / wheel portable suite: target test-install (same option), or configure test/foreign directly — see that option page and test/foreign/README.md.

• Wheel smoke script: packaging/python/test_wheels.sh (documented under Building Python Wheels).

• Coverage workflow: Code Coverage.

• Sanitizers / debugging: Diagnosis and Debugging.

• Mac Binary Package (Apple M1 and Mac x86_64)
  • Dependencies
  • Signing and Notarization
• Building Python Wheels
  • Linux wheels
  • macOS wheels
  • Launch the wheel building
  • Testing the wheels
  • Publishing the wheels on Pypi via Azure
  • Publishing the wheels on Pypi via CircleCI
  • Nightly wheels
  • How to test Azure wheels locally
• CI dependency archive (ci/deps)
  • Operator manual
  • Concepts
  • Common commands
  • What is managed today
  • Adding the next download blocker
  • Related docs
• Windows build
  • Pre-requisites
  • Build Environment installation
  • Setting up Visual Studio Code
  • How to build NEURON
  • Troubleshooting
• Code Formatting
  • Dependencies
  • Instructions
  • Behind the scenes
• Code Coverage
  • Dependencies (Linux)
  • Instructions
  • Simplified Workflow
  • Changed-line coverage (pull requests)
• Diagnosis and Debugging
  • Segfault and crash.
  • NaN or Inf values
  • Different results with different nhost, nthread, or backend
  • GDB
  • GDB and MPI
  • The rr debugger
  • Valgrind
  • Valgrind + gdb
  • Sanitizers
• Profiling and performance benchmarking
  • Instrumentation
  • Running benchmarks
  • Running GPU benchmarks
  • Profiling With Intel Vtune
  • Using LIKWID With NEURON
  • Comparing LIKWID Profiles