module requirements

[PeterNSteinmetz]

I am a new person looking at the source code to implement a new form of cluster comparisons (@alejoe91) . Thus I forked the source code and cloned my own repository. Then I tried to test this setup by running the tests in core. This required installing a number of modules, which I was able to install and chose to install the latest versions.

This however creates several failures due to the current spikeinterface being written to older versions. Specifically I had to downgrade

probeinterface to 0.2.28
zarr to 2.18.7

in order to pass these tests.

This suggests that spikeinterface may benefit from a proper requirements.txt file with version limits where needed.

After these downgrades I was able to run all tests in core.

[alejoe91]

Hi @PeterNSteinmetz

Requirements are in the pyproject.toml and include several "extra" installations. They are up to date and pin dependencies as needed (e.g. zarr).

How are you installing the package?

[PeterNSteinmetz]

Hi @alejoe91 . I have not worked on a project with this pyproject.ml before. I am working in PyCharm.

I had to look it up but apparently after creating the PyCharm project for the source directory and selecting an interpreter, one opens the python terminal and runs 'pip install .' That seems to have worked. Thanks for the input. I am studying the source to determine how to add the adjusted mutual information comparison now.

[chrishalcrow]

Hi Peter, note that if you run pip install '.[test]' all the packages required for testing will be installed, which can be handy. This is explained (briefly!) in the developer docs: https://spikeinterface.readthedocs.io/en/stable/development/development.html#how-to-run-tests-locally