Skip to main content

Agent-friendly local index for Janelia FlyLight Split-GAL4 and GAL4/LexA resources

Project description

flylight

Agent-friendly local index for Janelia FlyLight Split-GAL4 and GAL4/LexA resources.

Surfaces used:

Source order:

  1. release manifest json
  2. per-line/per-image S3 metadata json
  3. CGI release summary html
  4. GAL4/LexA line catalog + per-line imagery html

CLI

PyPI with pipx:

pipx install flylight

PyPI with plain pip:

python3 -m pip install flylight

Homebrew:

brew tap gumadeiras/tap
brew install flylight
flylight --version

From source:

python3 -m pip install -e .

Release

Current release: v0.12.5.

Tag pushes like vX.Y.Z run the release workflow: build artifacts, create a GitHub release, publish to PyPI, and update gumadeiras/homebrew-tap.

Release prerequisites:

  • PyPI trusted publishing configured for this repo.
  • HOMEBREW_TAP_TOKEN repository secret can write to gumadeiras/homebrew-tap.

Entry:

flylight --help
python3 janelia_splitgal4.py

Common commands:

flylight update --all
flylight sources --json
flylight find DNp04
flylight images MB005B
flylight line SS00724
flylight image 6878306
flylight release 'MB Paper 2014'
flylight examples --topic quick-start

Examples:

flylight update --all
flylight sources --json
flylight find R10A --source-kind flew-html
flylight images R10A01 --source-kind flew-html
flylight releases --json
flylight sync --release 'MB Paper 2014'
flylight sync --all
flylight sync --release 'FlyLight GAL4/LexA Collection'
flylight sync --all --force
flylight sync --all --offline
flylight sync --all --refresh-cache
flylight sync --release 'Descending Neurons 2018' --workers 8
flylight sync-plan --all
flylight sync-plan --release 'MB Paper 2014' --offline
flylight reindex --json
flylight cache-info --json
flylight schema --entity line
flylight examples --topic release-diff
flylight snapshot-export --out data/flylight-snapshot.tar.gz
flylight snapshot-import data/flylight-snapshot.tar.gz --force
flylight search --expressed-in DNp04 --ad 31B08 --source-kind line-metadata
flylight search --em-cell-type EPG
flylight search --source-kind flew-html --line R10A
flylight search-text 'DNp04 AND 31B08'
flylight search-images --area Brain --objective 20x --robot-id 3007645
flylight search-images --em-cell-type EPG
flylight show-line SS00724 --release 'Descending Neurons 2018'
flylight show-image 6878306
flylight compare-line MB005B
flylight compare-release 'MB Paper 2014' 'MB Paper 2015'
flylight show-release 'MB Paper 2014' --include-lines --genotype 34A03
flylight stats --json
flylight export-ndjson --entity line --release 'Descending Neurons 2018'
flylight export-ndjson --entity image --term MB005B --out data/mb005b.ndjson
flylight export-ndjson --entity release
flylight export-ndjson --entity compare-line --line MB005B
flylight export-ndjson --entity compare-release --left-release 'MB Paper 2014' --right-release 'MB Paper 2015'

Notes

  • HTTP fetches are cache-first by default; cached responses are reused until you pass --refresh-cache.
  • --offline disables network access and uses cached HTTP responses only.
  • cache path: data/http_cache
  • bare flylight prints the main help menu; bare subcommands print command-specific help.
  • update is the simple all-source sync shortcut and requires explicit --all.
  • sync and update report planning, skip, and sync progress to stderr; JSON output stays on stdout.
  • sync-plan is a dry-run: source kind, cache coverage, db coverage, skip vs sync decision.
  • reindex rebuilds derived searchable fields from stored raw image payloads; use it after schema upgrades on an existing db.
  • snapshot-export bundles sqlite + raw manifests + HTTP cache for portable offline reuse.
  • snapshot-import restores that bundle on another machine or working copy.
  • schema shows agent-facing row shapes and producer commands.
  • examples shows canned command recipes for common agent workflows.
  • sync --all is incremental by default; unchanged releases skip.
  • cache-info also reports cache suffix counts and oldest/newest cached timestamps.
  • missing release manifest: fallback walks line dirs + metadata jsons.
  • CGI summary enriches line-level fields like expressed-in, genotype, AD, DBD.
  • the GAL4/LexA catalog syncs as FlyLight GAL4/LexA Collection with source_kind=flew-html; it indexes line names from flew.cgi plus per-line imagery metadata from view_flew_imagery.cgi.
  • GAL4/LexA incremental sync tokens include the catalog and cached per-line imagery pages; missing page cache forces a conservative resync.
  • line/image exports include normalized arrays alongside text fields.
  • line/image records now include normalized em_cell_types derived from raw em_cell_type metadata when present.
  • search supports field filters over line metadata: AD, DBD, genotype, expressed-in, robot-id, source-kind.
  • search and search-images also support exact --em-cell-type matching.
  • search-text uses SQLite FTS for faster boolean/full-text matching over line text fields.
  • search-images supports field filters over image metadata: area, objective, gender, robot-id, roi.
  • compare-line shows shared fields for the same line across synced releases.
  • compare-release summarizes added, removed, changed, and unchanged lines between two synced releases.
  • export-ndjson also supports compare-line and compare-release entities for agent ingest.
  • local db path: data/janelia_splitgal4.sqlite
  • raw manifest cache: data/raw_manifests/*.json

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

flylight-0.12.5.tar.gz (37.9 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

flylight-0.12.5-py3-none-any.whl (35.0 kB view details)

Uploaded Python 3

File details

Details for the file flylight-0.12.5.tar.gz.

File metadata

  • Download URL: flylight-0.12.5.tar.gz
  • Upload date:
  • Size: 37.9 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/6.1.0 CPython/3.13.12

File hashes

Hashes for flylight-0.12.5.tar.gz
Algorithm Hash digest
SHA256 c6f515b78f3309642bec72eb1069b7b25fb17f3093e50fb3a720baac7076955c
MD5 f113b4ecb1615f730274d2f1afd315a1
BLAKE2b-256 bfd4c1755e51dd066e717f34375cf6638e8f9e240c604f08b4dcf89ec96467da

See more details on using hashes here.

Provenance

The following attestation bundles were made for flylight-0.12.5.tar.gz:

Publisher: release.yml on gumadeiras/flylight-cli

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

File details

Details for the file flylight-0.12.5-py3-none-any.whl.

File metadata

  • Download URL: flylight-0.12.5-py3-none-any.whl
  • Upload date:
  • Size: 35.0 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/6.1.0 CPython/3.13.12

File hashes

Hashes for flylight-0.12.5-py3-none-any.whl
Algorithm Hash digest
SHA256 822ead8a4a03d8bf929b8a82708ff168ff935f00543f1944f326b852188cf309
MD5 e6a8546f4d0ab475ba76516f5d308422
BLAKE2b-256 e70dc4452d6626075cf4ecbe9f791dfaf599ba6ae59ecb65550a67c553eca4b7

See more details on using hashes here.

Provenance

The following attestation bundles were made for flylight-0.12.5-py3-none-any.whl:

Publisher: release.yml on gumadeiras/flylight-cli

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page