Example Map¶

Use this quick map to find the script that matches your goal:

First impressions – Start with the demos in CANN Network Examples. cann1d_oscillatory_tracking.py and cann2d_tracking.py animate 1D/2D CANN bumps side by side.
Hebbian memory – Head to Hebbian Memory Examples for hopfield_train.py and hopfield_train_mnist.py. They show how to drive HebbianTrainer with image and digit data.
Navigation & tasks – Examples that integrate trajectories, external data, or path integration live in Tasks and Navigation Examples.
Experimental analysis – If you need Hugging Face datasets, bump fitting, or topology, jump to Experimental Analysis Examples.
End-to-end pipelines – Theta sweep automation, file exports, and batch workflows are summarised in Theta Sweep Pipeline Examples.

Ready-to-run setup¶

Create the environment
```
make install
```
Run a script with uv (example below launches cann1d_oscillatory_tracking.py):
```
uv run python examples/cann/cann1d_oscillatory_tracking.py
```
Review artefacts – Most scripts emit GIFs/PNGs/NPZ files. The filename is usually printed near the end of the script.

Notebook shortcuts¶

In addition to scripts, docs/en/notebooks/01_quick_start.ipynb and docs/en/notebooks/00_design_philosophy.ipynb provide interactive walkthroughs. The README links to Binder and Colab for zero-install exploration.

What’s next¶

The remaining chapters (CANN Network Examples through Theta Sweep Pipeline Examples) follow a consistent format: script overview → reasoning → key API references → extension ideas. Feel free to dip into the sections you need or read straight through for a complete tour of the toolkit.