Example Handbook Overview

This guide organizes the repository examples by theme so you can jump straight to a reference implementation. Each chapter lists the matching examples/ path, the primary modules involved, the artefacts the script produces, and ideas for extending it.

Running Notes

• Run make install first to prepare dependencies, then execute a script with uv run python <example.py>.

• Examples that emit GIF/PNG/NPZ files write to the example directory (or the project root) by default; tweak the script arguments if you need a different location.

• Plots that normally pop up a GUI window default to show=False so they work on headless machines—enable the flag if you want interactive figures.

Example Categories

Chapters

• Example Map
  • Ready-to-run setup
  • Notebook shortcuts
  • What’s next
• CANN Network Examples
  • cann1d_oscillatory_tracking.py
  • cann1d_tuning_curve.py
  • cann2d_tracking.py
  • theta_sweep_grid_cell_network.py
  • More scripts
• Hebbian Memory Examples
  • hopfield_train.py
  • hopfield_train_mnist.py
  • Custom models
• Tasks and Navigation Examples
  • import_external_trajectory.py
  • hierarchical_path_integration.py
  • Tips
  • Closed-loop navigation utilities
• Experimental Analysis Examples
  • experimental_cann1d_analysis.py
  • experimental_cann2d_analysis.py
  • Tools & dependencies
• Theta Sweep Pipeline Examples
  • theta_sweep_from_external_data.py
  • advanced_theta_sweep_pipeline.py
  • Usage tips
• Putting It Together
  • Pick modules as needed
  • Rapid prototyping checklist
  • Common pitfalls
  • Next steps