Skip to content

Commit 1806a1b

Browse files
committed
docs: add H1 interface to API
1 parent 32e4868 commit 1806a1b

File tree

1 file changed

+27
-0
lines changed

1 file changed

+27
-0
lines changed

docs/api.md

Lines changed: 27 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -885,12 +885,39 @@ from navis.interfaces import microns
885885

886886
| Function | Description |
887887
|----------|-------------|
888+
| [`microns.get_cave_client()`][navis.interfaces.microns.get_cave_client] | {{ autosummary("navis.interfaces.microns.get_cave_client") }} |
888889
| [`microns.fetch_neurons()`][navis.interfaces.microns.fetch_neurons] | {{ autosummary("navis.interfaces.microns.fetch_neurons") }} |
889890
| [`microns.get_somas()`][navis.interfaces.microns.get_somas] | {{ autosummary("navis.interfaces.microns.get_somas") }} |
890891

891892
Please also see the [MICrONS tutorial](../generated/gallery/4_remote/tutorial_remote_02_microns/).
892893

893894

895+
### H1 dataset
896+
897+
Functions to fetch neurons (including synapses) from the
898+
[H1](https://h01-release.storage.googleapis.com/landing.html) connectome dataset.
899+
900+
Requires `caveclient` and `cloud-volume` as additional dependencies:
901+
902+
```shell
903+
pip3 install caveclient cloud-volume -U
904+
```
905+
906+
Not imported at top level! Must be imported explicitly
907+
908+
```python
909+
from navis.interfaces import h01
910+
```
911+
912+
| Function | Description |
913+
|----------|-------------|
914+
| [`h1.get_cave_client()`][navis.interfaces.h1.get_cave_client] | {{ autosummary("navis.interfaces.h1.get_cave_client") }} |
915+
| [`h1.fetch_neurons()`][navis.interfaces.h1.fetch_neurons] | {{ autosummary("navis.interfaces.h1.fetch_neurons") }} |
916+
| [`h1.get_somas()`][navis.interfaces.h1.get_somas] | {{ autosummary("navis.interfaces.h1.get_somas") }} |
917+
918+
Please also see the [H1 tutorial](../generated/gallery/4_remote/tutorial_remote_04_h1/).
919+
920+
894921
### R interface
895922

896923
Bundle of functions to use R natverse libraries.

0 commit comments

Comments
 (0)