nanoporetech / nanoporetech/minknow_api

Plan for Renaming Guppy in Manager?

Open
#69 0 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

Dominant language
Python
Stars
73
Forks
16
PR merge metrics
No merged PRs in 30d

Description

In the v6 breaking change, one of the change was the switch from "guppy" to "basecaller" in instances.

However it appears that the manager API still had guppy remaining in it.

https://github.com/nanoporetech/minknow_api/blob/02492501d51ac41d8ce168074c44aae66d43eb6f/proto/minknow_api/manager.proto#L783-L785

Correspondingly, the Python API minknow_api also has the guppy_version property in Manager object. The socket still remains /tmp/.guppy/5555 as of now.

I wonder if these would also be renamed to "basecaller" in a later major release, or if they would stay this way for the foreseeable future.

Contributor guide

No contributing guide indexed for this repository

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Research direction

Review proto/minknow_api/manager.proto at lines 783-785, the Python minknow_api Manager object's guppy_version property, and the /tmp/.guppy/5555 socket reference. Determine whether these names should be changed to basecaller and define the compatibility and release scope; done means an agreed renaming plan or explicit decision to retain them.

Written by the indexing model from the issue text.

Assessment

Tech stack
python
Domain
api
Issue type
Refactor
Difficulty
5/5
Estimated time
Over a week
Activity status
Stale
Clarity
Needs clarification
Newbie friendliness
25/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.