ecephys_spike_sorting icon indicating copy to clipboard operation
ecephys_spike_sorting copied to clipboard

Docs build is broken

Open NileGraddis opened this issue 6 years ago • 4 comments

sphinx.apidoc was moved to sphinx.ext.apidoc and a reroute was added to cover. This reroute strips out the first element passed to it, which breaks our docs build.

NileGraddis avatar Jun 18 '18 23:06 NileGraddis

oh dang, matlab's python bindings are a dependency. I don't actually know much about how those work. @jsiegle how are you guys handling this deployment currently? It might make sense to deploy the matlab python bindings to our internal artifactory server, so that they can be easily installed.

NileGraddis avatar Jun 19 '18 16:06 NileGraddis

So, the spike sorting code is dependent on 3 pieces of "external" software: NpxExtractor, a binary that converts raw data files into arrays of int16s, SpikeBandMedianSubtraction, another binary that removes common-mode noise from the continuous data, and Kilosort2, which does the actual spike sorting. Kilosort2 is what requires the matlab python bindings.

Putting the matlab engine on the artifactory server sounds like a good idea—can you show me how to do that?

What's the best way to make sure the other elements are installed and up-to-date?

jsiegle avatar Jun 19 '18 17:06 jsiegle

I don't have read access to those stash repos.

Without knowing how the matlab engine is structured it is difficult to say what would be needed to deploy it to artifactory. Maybe we could sit down and walk through how you guys deploy it on your machines?

NileGraddis avatar Jun 19 '18 18:06 NileGraddis

I just made them public.

The matlab engine comes with the Matlab install, but you have to run setup.py install to use it. The version for R2017a is only compatible with Python 3.5 or lower, so that's something we'll have to keep in mind.

jsiegle avatar Jun 19 '18 19:06 jsiegle