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.14.tar.gz (146.9 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.14-py3-none-any.whl (275.3 kB view details)

Uploaded Python 3

File details

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

File metadata

  • Download URL: webknossos-0.10.14.tar.gz
  • Upload date:
  • Size: 146.9 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: poetry/1.1.14 CPython/3.8.13 Linux/5.15.0-1017-azure

File hashes

Hashes for webknossos-0.10.14.tar.gz
Algorithm Hash digest
SHA256 d7998ff7e8d51fd8e1537719bc063b273bdd46e984aee89fc80173f7aacb2a16
MD5 f820e6e7f05a3f4a2ee43bdf617643c4
BLAKE2b-256 47706fbeb3fbb208882a234001301efa260909fd7a20e37dbf8290095ba4bc4e

See more details on using hashes here.

File details

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

File metadata

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

File hashes

Hashes for webknossos-0.10.14-py3-none-any.whl
Algorithm Hash digest
SHA256 14764fcb6f9468af424ea0bffd461336ac063a92de633c7958786fdb16a75ad4
MD5 141bdb510034108863c60b49020cb8b7
BLAKE2b-256 579b4c7dcda85c707fc446cc4abf4511f015ef9341bb30d50088e0d40a59bc15

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