navis-org / navis

Python library for analysis of neuroanatomical data.
https://navis-org.github.io/navis/
GNU General Public License v3.0
83 stars 33 forks source link

H01 interface #159

Closed jinhan closed 2 months ago

jinhan commented 2 months ago

Hi Phillipp, I'm Jinhan, working with Jakob at Harvard Lichtman Lab. We would like to provide a Navis interface to extend the accessibility of the H01 dataset.

schlegelp commented 2 months ago

Hi Jinhan. An interface to the H01 dataset sounds great!

I'm slightly confused by some of the changes in 91fb50c though. For example, you seem to have removed the xform_image function from cmtk.py. Is it possible that you copied some files from an older version of navis?

I would suggest you start with a fresh fork, only add navis/interfaces/h01.py + tests/test_module_h01.py and make a new PR.

Two additional notes for your consideration:

  1. I recently changed the docs from Sphinx to Mkdocs and if you want to add a tutorial (which I highly recommend), you need to put a .py script called e.g. plot_04_remote_h01.py into /docs/examples/3_interfaces/. Note that these examples use the # %% syntax to delineate cells.
  2. Both, the examples in docstring as well as the tutorials in /docs/examples/ are tested during CI. You might not actually need tests/test_module_h01.py.