https://github.com/michaeljohnclancy/examplesfkacherysetup

https://github.com/michaeljohnclancy/examplesfkacherysetup

Last synced: 3 months ago
JSON representation

• Host: GitHub
• URL: https://github.com/michaeljohnclancy/examplesfkacherysetup
• Owner: michaeljohnclancy
• Created: 2021-10-04T10:35:55.000Z (over 3 years ago)
• Default Branch: master
• Last Pushed: 2021-10-04T11:16:36.000Z (over 3 years ago)
• Last Synced: 2025-01-12T10:12:19.772Z (5 months ago)
• Language: Python
• Size: 1.95 KB
• Stars: 1
• Watchers: 2
• Forks: 2
• Open Issues: 0
• Metadata Files:
  • Readme: README.md

Awesome Lists containing this project

README

        
Kachery consists of two elements:

  1. Kachery-daemon, a server/node which communicates with other nodes across the p2p network. 

    - It works by being authorized to join certain "channels", which are basically data sources.

      - An example of a channel could be the SpikeForest channel. (This channel is joined in Installation part 5)

    - Optional, but could be ran as a system service on startup of your PC, platform specific.

  2. Kachery-client, which exposes an interface to python.

    - This is used to communicate with your local kachery node (kachery-daemon).

    - If you ask your node for a particular 

Kachery documentation can be found here: https://github.com/kacheryhub/kachery-doc

Installation:

1. Create new virtual environment, with virtualenv/pyenv etc. (I don't use conda so can't help there)

2. Install numpy and kachery-client inside python environment.

3. Either:

  - Install kachery-daemon globally on your system

  - Install kachery-daemon in the environment created above

4. Start your kachery daemon instance:

  

  - As per the kachery documentation (https://github.com/kacheryhub/kachery-doc/blob/main/doc/hostKacheryNode.md#running-the-daemon):

    - kachery-daemon-start --label  --owner 

    - You must run this from the same environment that you installed kachery-daemon in.

  

5. Registration of kachery node:

  - Using the same google account email you used to start the kachery node, log into https://www.kacheryhub.org/

  - Click "Register a new node"

  - With the kachery instance running, run "kachery-daemon info" to retrieve your node ID.

  - Complete node registration with this node ID.

6. Join spikeforest channel:

  - Click on your node in Kacheryhub, and click "Join a channel for this node"

  - Join a channel with channel name "spikeforest"

  - After joining, add the passcode "sf-rMIASUHn" to the node configuration.

  - Restart your local kachery node for changes to take effect.

7. Trying out your installation:

  - Enter the environment where your kachery-client is installed, ensuring kachery-daemon is running with the above configuration completed.

  - Run the test file in this repo: DataRetrieval.py

  - If you get a load json printed out in the console the setup has succeeded.

Troubleshooting

1. If you have used kachery in the past, ensure the most recent version is installed, of both the daemon and the client.

2. On upgrading, my node started running with a differnt node ID, making me unable to retrieve data.

  - If this is the case for you, remove the old kachery-node from kacheryhub and add the new one, with the required spikeforest config.