Skip to main content

Python package to work with webKnossos datasets and annotations

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

Project details


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.9.6.tar.gz (110.4 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.9.6-py3-none-any.whl (209.5 kB view details)

Uploaded Python 3

File details

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

File metadata

  • Download URL: webknossos-0.9.6.tar.gz
  • Upload date:
  • Size: 110.4 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: poetry/1.1.11 CPython/3.8.12 Linux/5.11.0-1028-azure

File hashes

Hashes for webknossos-0.9.6.tar.gz
Algorithm Hash digest
SHA256 057aa505852e4dc6d9a58241bb257d4db5c371fd5621b36d136779ed30dd650a
MD5 10a6e67b39b7ec0c6d86adf9c33b1e9f
BLAKE2b-256 2a102817111e8150e8b77bdb4a0912ca6885f8aeb2594e39ebbd58525e5abd2a

See more details on using hashes here.

File details

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

File metadata

  • Download URL: webknossos-0.9.6-py3-none-any.whl
  • Upload date:
  • Size: 209.5 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: poetry/1.1.11 CPython/3.8.12 Linux/5.11.0-1028-azure

File hashes

Hashes for webknossos-0.9.6-py3-none-any.whl
Algorithm Hash digest
SHA256 778eee48aa7d857ba2a61ce7e6d539c10e464d87607b00b475ecc528f0d3892f
MD5 4d12bad2a2fa2bfe5db2a8f4b3c94bde
BLAKE2b-256 7ff31c1caa144261e661853f28f2a249eb31a7043fb370c9c8377925f69aa40c

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