Skip to content

← Connect an app

Install LabConstrictor Tools

You do not install labconstrictor-tools to use an app: the app's installer brings it. To install an app or a plugin, follow Install an app and the napari, Fiji or QuPath guide.

Shared and network installs are in Operations.

What the plugins need from an app

  • labconstrictor-tools 0.3.0a1 or newer in the app (tag v0.3.0-alpha.1 or later). Fiji and QuPath leave out an app with an older or unknown Tools, or one without the features they need, and say why in their Log, for example: this app's labconstrictor-tools 0.2.0rc1 is older than the 0.3.0a1 this host needs: update it. The napari plugin itself requires labconstrictor-tools>=0.3.0a1. An app whose installer pins an older Tools works in the plugins only after a new release of the app (Pinning Tools in app installers).
  • At least one registered app. A plugin with no app says so. Install an app, then rescan or restart the host.
  • The host named in the app's hosts: line (PROTOCOL.md). Installing a plugin does not install any app.

Check an installed app

Run these with the app's own Python. On macOS and Linux:

<install folder>/bin/python -m labconstrictor_tools list
<install folder>/bin/python -m labconstrictor_tools doctor

On Windows:

<install folder>\python.exe -m labconstrictor_tools list
<install folder>\python.exe -m labconstrictor_tools doctor

list shows the app and its tools; doctor should show no cross. If a plugin's list is empty or an app is missing, these commands say why (an interpreter that is gone, a Tools that is too old). The log is ~/.labconstrictor/logs/labconstrictor.log (Operations).

Install labconstrictor-tools by hand

For development, or to add Tools to an environment yourself. The package is not on PyPI: install the source archive of a release tag, never main (Releases and tags). Take the newest tag from the Releases page:

python -m pip install https://github.com/CellMigrationLab/LabConstrictor-Tools/archive/refs/tags/<tag>.zip

The address is a source archive, so no git is needed. For an editable install of a checkout, see the README.

Edit this page on GitHub