Skip to main content

Python API for working with webKnossos datasets, annotations, and for webKnossos server interaction.

Project description

webKnossos Python Library

PyPI version Supported Python Versions Build Status Documentation Code Style

Python API for working with webKnossos datasets, annotations, and for webKnossos server interaction.

For the webKnossos server, please refer to https://github.com/scalableminds/webknossos.

Features

  • easy-to-use dataset API for reading/writing/editing raw 2D/3D image data and volume annotations/segmentation in webKnossos wrap (*.wkw) format
    • add/remove layers
    • update metadata (datasource-properties.json)
    • up/downsample layers
    • compress layers
    • add/remove magnifications
    • execute any of the wkCuber operations from your code
  • manipulation of webKnossos skeleton annotations (*.nml) as Python objects
    • access to nodes, comments, trees, bounding boxes, metadata, etc.
    • create new skeleton annotation from Graph structures or Python objects
  • interaction, connection & scripting with your webKnossos instance over the REST API
    • up- & downloading annotations and datasets

Please refer to the documentation for further instructions.

Installation

The webknossos package requires at least Python 3.7+.

You can install it from pypi, e.g. via pip:

pip install webknossos

Examples

See the examples folder or the the documentation.

Contributions & Development

Please see the respective documentation page.

License

AGPLv3 Copyright scalable minds

Release history Release notifications | RSS feed

Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

webknossos-0.10.20.tar.gz (152.1 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

webknossos-0.10.20-py3-none-any.whl (287.1 kB view details)

Uploaded Python 3

File details

Details for the file webknossos-0.10.20.tar.gz.

File metadata

  • Download URL: webknossos-0.10.20.tar.gz
  • Upload date:
  • Size: 152.1 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: poetry/1.1.14 CPython/3.8.14 Linux/5.15.0-1020-azure

File hashes

Hashes for webknossos-0.10.20.tar.gz
Algorithm Hash digest
SHA256 fd9ace2df237ffb1f7ddcb9a3eb2f4ff515f376385ca05ac1cce18c19e91c67b
MD5 192ab41ed5d4b329e9e55941bffb8caa
BLAKE2b-256 9a3bf7da1bfb25cfa4b69a9a2d9f36080c72b71d372c786f257b63014f5fde51

See more details on using hashes here.

File details

Details for the file webknossos-0.10.20-py3-none-any.whl.

File metadata

  • Download URL: webknossos-0.10.20-py3-none-any.whl
  • Upload date:
  • Size: 287.1 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: poetry/1.1.14 CPython/3.8.14 Linux/5.15.0-1020-azure

File hashes

Hashes for webknossos-0.10.20-py3-none-any.whl
Algorithm Hash digest
SHA256 a3242fc5b37f71b267a51d05f719b4a65c7ab62b851c6fbe3cff2f0ec73eba19
MD5 802271a2b26b184a6eb0693ae194b947
BLAKE2b-256 e0f971a65d0b2a989234ba4eac4a687a8126e6b106f5e9268b072a724c5326bf

See more details on using hashes here.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page