FlyBrain.load("male-cns-escape-v1", download=True) fetches a 3.8 MB,
SHA256-pinned model from an immutable source commit. Later calls can omit
download=True to verify and use the local cache. It contains 313 real MaleCNS
neurons and 20,607 edges, with assumed LIF parameters and artificial IO mappings.
See the model card and reproduction recipe.
The catalog status ready means loadable by this SDK, not biologically validated.
The raw-data entries below still require conversion. MaleCNS source SHA256 pins
are computed from official downloads by this project, not publisher signatures.
The SDK ships URLs and metadata, not bulk biological datasets. Listing models is
offline. Downloads happen only through explicit load(..., download=True), fetch_model()
or the models download command. This makes a small installation useful immediately, while allowing
contributors to add sources over time.
| Catalog ID | Runnable now? | Files |
|---|---|---|
toy |
Yes, builtin | 12 synthetic neurons / 12 edges |
male-cns-escape-v1 |
Yes, experimental | 313 real source neurons / 20,607 edges; 3.8 MB |
male-cns-v1.0 |
No; raw data | Connections 1,051,241,946 B; annotations 14,483,314 B; transmitter predictions 43,282,834 B |
flywire-v783 |
No; raw data | Proofread connections 852,022,274 B; neuron IDs 1,114,168 B |
Sources: MaleCNS official downloads, FlyWire pinned archive. Both catalog entries retain CC-BY-4.0 attribution requirements. Metadata and file sizes were checked on 2026-09-09. Upstream files can change; report a failed size/checksum verification.
from flybrain import fetch_model
paths = fetch_model(
"male-cns-v1.0",
assets=["annotations"],
cache_dir="./data-cache",
max_bytes=20_000_000,
)Default cache: ~/.cache/flybrain-sdk/<catalog-id>/. Set cache_dir to keep it
elsewhere. assets=None downloads every catalog asset for the selected entry;
select assets to avoid unneeded downloads. The default 2 GB limit is per asset.
Inspect total sizes using model_info() first. Downloads stream to temporary files,
verify declared size and any available pinned checksum, then replace the target.
Interrupted/invalid transfers leave no partial target. There is no resume support
or multi-process cache locking in this alpha.
FlyWire archive MD5 values are pinned as published upstream; they detect transfer corruption, not adversarial tampering. MaleCNS source SHA256 values are pinned from this project’s official-URL downloads; HTTPS, size and pins are checked, then a SHA256 receipt is recorded on first fetch. Subsequent cache reads re-hash against that receipt. A local receipt is not independent source authentication. Adding publisher-verified SHA256 pins is welcome. The downloader rejects HTML login pages and never unpickles or executes a download.
To add a model, edit src/flybrain/data/registry.json through a pull request.
Include immutable/versioned HTTPS URLs, byte sizes, license, source/citation links,
checksums where possible and status (builtin, raw-data, or ready).
Do not mark raw wiring as a runnable physiological model. A ready status
needs an importer plus explicit parameter/mapping files and appropriate validation. The escape recipe is the first implemented example.