diff --git a/README.md b/README.md index a37c44b..7b361a0 100644 --- a/README.md +++ b/README.md @@ -42,6 +42,61 @@ bypass (used by the tests), and version-based invalidation; and [RELEASING.md](RELEASING.md) for how the single-source version (`_version.py`) is bumped from the release tag. +## πŸ•ΈοΈ CATMAID pass-through + +VFB hosts public, read-only CATMAID servers for several connectomics datasets +(FAFB, FANC, L1EM, ...; registry at +). `vfbquery` exposes their +query API directly, and anywhere a command takes skeleton ids you can pass +CATMAID skids, VFB ids (`VFB_xxxxxxxx`) or a mixed list β€” VFB ids are converted +through the knowledge graph's cross-references before the request is made. + +```python +import vfbquery as vfb +from vfbquery import catmaid + +vfb.list_catmaid_instances() # hosted instances + tokens + projects +vfb.list_catmaid_commands() # the curated read-only command registry + +fafb = catmaid('fafb') # optionally catmaid('fanc', project=2) +fafb.commands() # {command: doc} + +# Mixed VFB ids and skids; the envelope carries the id mapping both ways: +fafb.connectivity(ids=['VFB_001011rj', 10603863], boolean_op='OR') +fafb.neuron_names(ids=['VFB_001011rj']) +fafb.swc(id='VFB_001011rj') # single-id commands take id= +fafb.swc_alignments(id='VFB_001011rj') # spaces an SWC is available in +fafb.swc(id='VFB_001011rj', aligned='JRC2018Unisex') # VFB's template-registered copy +# (aligned=